close
API Reference
HomeLOGIN

List appointments

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

List appointments for resources filtered by a time interval.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Timezone in which your local branch is located Note: this field is mandatory if your branch's timezone is not UTC

date
required

Specify the start date for your search in the format YYYY-MM-DD.
from_date works with to_date. The maximum period is 31 days

date
required

Specify the end date for your search in the format YYYY-MM-DD.
from_date works with to_date. The maximum period is 31 days

string
required

Specify the start date for your search. The date format is YYYY-MM-DD HH:mm.
Please note you must use the to_date parameter as well. You can't set a period larger than 31 days

string
required

Specify the end time for your search. The date format is YYYY-MM-DD HH:mm.
Please note you must use the from_time parameter as well. You can't set a period larger than 31 days

resource_ids[]
array of strings

Filter appointments by specific resources. This attribute is an array of resource IDs. Example: /?resource_ids[]=id1&resource_ids[]=id2

resource_ids[]
string

Filter appointments for a specific customer.

customer_ids[]
array of strings

If you want to receive appointments for customers, by sending the array of customer IDs. Example: /?customer_ids[]=id1&customer_ids[]=id2

customer_ids[]
service_id[]
array of strings

Filter appointments for a specific service.
Example: /?service_id[]=id1

service_id[]
string

If you want to receive appointments for a specific group service you can use this parameter.
Example: /?group_service_id=id1

string
enum
Allowed:
string

search events based on customer/participant name or service title

boolean

If this parameter is not specified, the default is false. When it is true the request will return only appointments of courses

integer

Set the page for the results which should be returned.
If the parameter is not specified, all the data is returned. This may cause timeouts due to large amounts of data.
note: Also it must be used in combination with the limit parameter, if limit is not specified but page is, no pagination will be applied to the result.

integer

Set the number of results per page.
If the parameter is not specified, all the data is returned. This may cause timeouts due to large amounts of data.
note: Also it must be used in combination with the page parameter, if page is not specified but limit is, no pagination will be applied to the result.

Headers
string
required

Id of the company

Responses

Updated 2 months ago

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

Updated 2 months ago

Did this page help you?