📘

Search

Possible search attributes are:

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

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.

📘

Dynamic includes

In addition to the basic booking data, you can fetch the following booking-related data:

• resource
• logs
• attributes
• customers
• calendar
• event
• meta
• project
• widget
• available_actions
• customer_action_links (learn more)
• related_bookings (see group bookings)
• owner_booking (see group bookings)

Example:
https://api.timekit.io/v2/bookings?include=logs,attributes,customers,calendar,event

📘

Samples

You can combine the Search and Dynamic includes as well.

If, for example, you wanted to do a search for all cancelled bookings and also show the attributes for them, you can use a GET to:

https://api.timekit.io/v2/bookings?search=state:cancelled&include=attributes