You can authenticate to the Cheqroom API using API tokens. API tokens can be managed through Settings > Integrations > API.
Make sure to authenticate each API request by sending the API token in the Authorization header of the request.
For all upcoming requests, when there is some text (parameter) between [] in blue, you must replace the entire word with the requested input.
[[email protected]] needs to be replaced with [email protected][token] needs to be replaced with API Key[user-id] needs to be replaced with User ID associated with the API Key.| Type | Description | Examples |
|---|---|---|
| datetime | ISO formatted datetime | 2013-08-20T00:00:00Z, 2013-07-10T16:21:02.116+0000 |
| list | jQuery formatted arrays | name[]=Steve&name[]=John |
| boolean | Boolean fields | True, False |
| embedded doc fields | Python fields setting | profile__useOrders=True |
The double underscore after a field name is used to specify the query operator. This allows for more complex and specific queries to be performed.
name__ne=Vincent
name field is not Vincent.due__lt=2024-07-10T16:21:02.116+0000
due date is before the specified 2024-07-10T16:21:02.116+0000.due__lte=2024-07-10T16:21:02.116+0000
due date is before or on the specified 2024-07-10T16:21:02.116+0000.due__gt=2024-07-10T16:21:02.116+0000
due date is after the specified 2024-07-10T16:21:02.116+0000.