GET List all bookings

Use this endpoint to get all bookings

Search

Possible search attributes are:

resource.id
graph
state
completed (true/false)
customer.name (including wildcards)
customer.email
customer.
calendar.id
project.id
service.id
location.id
widget.id
meta.*

resource.id, calendar.id, project.id, service.id, location.id and widget.id must be valid UUIDs and customer.email must be a valid email address, otherwise the request is rejected with a 422.

Only one meta.* criterion is applied per request (the first one). If you search on both customer.name and customer.email, bookings matching either one are returned. A customer.<customer field name> criterion is ignored when customer.name or customer.email is also present.

Regarding meta you can search on key-value pairs like this: meta.[key]:[value], A complete example searching for the meta-key=foo and the value=bar: https://api.timekit.io/v2/bookings?search=meta.foo:bar

Regarding wildcards on customer.name, the wildcard is * and you can pre- and suffix the search string with the wildcard. For example if you want to search for all names beginning with Marty (for instance if you don't know that his last name is McFly) you would search by suffixing Marty with the wildcard like so: search=customer.name:marty* Also note that the customer.name search is case-insensitive.

You can also include several attributes in your search. For example, if you want all confirmed bookings for a specific resource, you can use https://api.timekit.io/v2/bookings?search=resource.id:RESOURCE_UUID;state:confirmed

The elements in the returned JSON is dependent on the graph and state of the booking.

Endpoint

GET https://api.timekit.io/v2/bookings

Parameters

Name	In	Type	Default	Description
`limit`	query	int	1000	Pagination limit intervals (X means first X is returned). The maximum is 1000; a higher value is rejected with a 422.
`page`	query	int	1	Which pagination interval to retrieve (set limit for interval size)
`search`	query	string		Add 1 or more search criteria to your query. Please see our search reference: https://developers.timekit.io/reference/search
`include`	query	string		Dynamic includes
`orderBy`	query	string		Order bookings by one of the following attributes: `created_at`, `updated_at`, `event.start`, `event.end`, `completed`, `graph`, `state`
`sortedBy`	query	string		Used together with `orderBy` to determine the direction of the sorting. Can be set to either `asc` or `desc`.
`start`	query	datetime		Filter bookings by when they start, must be accompanied by end.
`end`	query	datetime		Filter bookings by when they end, must be accompanied by start.
`start_after`	query	datetime		Only return bookings that start after this time, must be accompanied by start_before.
`start_before`	query	datetime		Only return bookings that start before this time, must be accompanied by start_after.

Request examples

curlcurl --request GET \
  --url https://api.timekit.io/v2/bookings?include=available_actions,attributes,calendar,customers \
  --header 'Content-Type: application/json' \
  --user :live_api_key_7nzvc7wsBQQISLeFSVhROys9V1bUJ1z7

Response examples

200

json{
  "data": [
    {
      "id": "58190fc6-1ec0-4ebb-b627-7ce6aa9fc703",
      "state": "completed",
      "graph": "confirm_decline",
      "completed": true,
      "created_at": "2016-02-11T12:39:45+0100",
      "updated_at": "2016-02-11T13:12:01+0100",
      "available_actions": [],
      "attributes": {
        "event_info": {
          "start": "1955-11-12T21:30:00-07:00",
          "end": "1955-11-12T22:15:00-07:00",
          "what": "Catch the lightning",
          "where": "Courthouse, Hill Valley, CA 95420, USA",
          "description": "The lightning strikes at 10:04 PM exactly! I need you to be there Doc!"
        }
      },
      "calendar": {
        "id": "bfa0b9fa-36aa-4ae6-8096-f3b20fbed1d2",
        "name": "Important encounters with Marty",
        "display_name": "Important encounters with Marty",
        "description": "Througout time, Marty and I really need to meet in order for the world not to collapse into Biffy cazyness.",
        "foregroundcolor": "#000000",
        "backgroundcolor": "#FFFFFF",
        "created_at": "2016-02-15T13:21:42+0100",
        "updated_at": "2016-02-15T13:21:42+0100"
      },
      "customers": [
        {
          "id": "a728e860-99c7-4009-8843-7d9ac5d7f53f",
          "name": "Marty McFly",
          "email": "marty.mcfly@timekit.io",
          "phone": "(916) 555-4385",
          "voip": "McFly",
          "timezone": "America/Los_Angeles"
        }
      ]
    },
	  {
      "id": "f68979ff-27da-4afd-8d0c-847f9340331b",
      "state": "tentative",
      "graph": "confirm_decline",
      "completed": false,
      "created_at": "2016-02-11T12:39:45+0100",
      "updated_at": "2016-02-11T13:12:01+0100",
      "available_actions": [
      	"confirm",
        "decline"
      ],
      "attributes": {
        "event_info": {
          "start": "1955-11-05T09:30:00-07:00",
          "end": "1955-11-05T09:45:00-07:00",
          "what": "Deliver the Pacard to the auto shop",
          "where": "Western Auto Store, Hill Valley, CA 95420, USA",
          "description": "The clutch needs tightening"
        }
      },
      "calendar": {
        "id": "c91c5d04-2a57-46c0-ab35-e489dadf132e",
        "name": "My personal calendar",
        "display_name": "My personal calendar",
        "description": "Notes to self, so I don't remember to to them.",
        "foregroundcolor": "#25d6be",
        "backgroundcolor": "#ea1cb8",
        "created_at": "2016-02-15T13:21:42+0100",
        "updated_at": "2016-02-15T13:21:42+0100"
      },
      "customers": [
        {
          "id": "78a4d873-2a68-41c6-bdd4-c0ca5b35efd3",
          "name": "Dr. Emmett Brown",
          "email": "doc.brown@timekit.io",
          "phone": "(916) 555-4385",
          "voip": "DocBrown",
          "timezone": "America/Los_Angeles"
        }
      ]
    }
  ]
}