Thanks to visit codestin.com
Credit goes to docs.timify.dev

API Reference
HomeLOGIN

Use this method to retrieve information about the availability of a specific service or a group service (ie course, workshop, event)

get
https://api.timify.com/v1/availability

For online bookable timeslots for services or group-service use the endpoint GET booker-services/availabilities
Response parameters:

  • keys 'data.calendarBegin' and 'data.calendarEnd' - this is the allowed period for the availability algorithm. Can be adjusted in the web app under the section 'Booking setup'
  • key 'data.onDays' - array of dates with available time slots
  • key 'data.offDays' - array of dates that are fully booked
  • key 'data.slots.times' - array of times that are available for appointments
    ​​​​​​​If besides knowing the days with free slots (onDays) and those without any (offDays), you want to have a list of free slots for very specific days, you can use the parameter days[] and you will have the list in the response field slots
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
Codestin Search AppLoading…
Query Params
string

Filter available timeslots by service id.
Only one of the parameters are required: service_id, duration or durations_pattern

string

Filter available timeslots by duration.
Search for an available time in one single interval.
Only one of the parameters are required: service_id, duration or durations_pattern

durations_pattern[]
array of integers

Filter by duration pattern in intervals of 5 (5, 10, 15, 60, 125 etc.)
The minimum duration is 5 minutes,
Example: /?durations_pattern[]=20,40,20
Only one of the parameters are required: service_id, duration or durations_pattern

durations_pattern[]
resource_ids[]
array of strings

Filter by a specific resource(s).
Example: /?resource_ids[]=id1&resource_ids[]=id2

resource_ids[]
days[]
array of strings

Filter by specific days.
Example: /?day[]=2019-04-23&day[]=2019-04-24

days[]
sresource_ids
array of strings

Filter by a specific resource(s). SECOND OPTION
Example: /?sresource_ids[]=id1&sresource_ids[]=id2

sresource_ids
integer

Filter by preparation time before an appointment.

integer

Filter by time after an appointment.

string
enum
Defaults to NONE

Filter by timeframes
Available options are: - "NONE" - the whole day, this is the default - "WORKING" - filtered by working day (adjusted in the web app) - "BOOKING" - filtered by bookable times (adjusted in the web app)

Allowed:
string

Set the timezone appointments is retrieved in.
Get all available timezones from this public endpoint: https://api.timify.com/timezones/ Example: "Europe/Berlin"

combination_services_ids[]
array of strings

Filter available timeslots by combination service ids.
Example: /?combination_services_ids[]=id1&combination_services_ids[]=id2

combination_services_ids[]
resource_external_category_ids[]
array of strings

Filter by a specific resource external category id(s).

resource_external_category_ids[]
string

use this parameter to receive only the attributes you need.
This parameter is flexible and allows many combinations.
Let's take for example this payload.

  {
    "a": "..."
    "b": "...",
    "c": {
      "d": "...",
      "e": "..."
    } 
  }

If you want to get "a" and "b" use this combination: fields=a,b
If on the other hand you want to get "a" and "d": fields=a,c/d
Finally if you want to get "b", "d" and "e": fields=b,c/(d,e)

Headers
string
required

Id of the company

Responses

Updated 3 months ago

Did this page help you?
Language
URL
Codestin Search AppLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?