Resources
Anything bookable: a worker, a room, a court. A resource is bookable only inside its schedules: one with none is closed until you give it hours. Capacity above 1 is a pool of identical units.
Create a resource
/v1/resourcesAdds something bookable to a business. It’s closed until you give it a schedule (POST /v1/schedules).
Send the business’s id in Tiempo-Account.
Body parameters
namestringrequiredShown in your dashboard; not to customers.
typestringrequiredYour label for grouping, for example worker, room or court.
capacityintegerHow many bookings it can hold at once. Defaults to 1.
timezonestringIANA name, for example Europe/London.
default_locationstringWhere the resource works when a schedule interval doesn’t say.
buffer_before_minutesintegerMinutes the resource is also held before the time (travel, setup), 0–1440. On a booking segment it overrides the resource’s default; the appointment’s start and end don’t change.
buffer_after_minutesintegerMinutes the resource is also held after the time (cleanup, turnaround), 0–1440. On a booking segment it overrides the resource’s default. Buffers must fit in working hours and can’t overlap blocks or other bookings.
metadatamapUp to 50 keys of your own (strings, keys up to 40 characters, values up to 500). Returned on every read and webhook. On update, an empty string removes a key.
List resources
/v1/resourcesSend the business’s id in Tiempo-Account.
Query parameters
typestringOnly this type. For events, an exact type or a prefix like booking.*.
statusstringOnly objects with this status.
default_locationstringOnly resources based at this location.
limitinteger1 to 100. Defaults to 20.
starting_afterstringAn object id from the previous page; returns the page after it.
ending_beforestringAn object id; returns the page before it.
metadata[key]stringOnly objects whose metadata has this key and value. Repeat for several.
Retrieve a resource
/v1/resources/{id}Send the business’s id in Tiempo-Account.
Path parameters
idstringrequiredThe object’s id.
Update a resource
/v1/resources/{id}Changing capacity or timezone re-checks the resource’s future bookings and flags any that no longer fit.
Send the business’s id in Tiempo-Account.
Path parameters
idstringrequiredThe object’s id.
Body parameters
namestringShown in your dashboard; not to customers.
capacityintegerHow many bookings it can hold at once. Defaults to 1.
timezonestringIANA name, for example Europe/London.
default_locationstringWhere the resource works when a schedule interval doesn’t say.
buffer_before_minutesintegerMinutes the resource is also held before the time (travel, setup), 0–1440. On a booking segment it overrides the resource’s default; the appointment’s start and end don’t change.
buffer_after_minutesintegerMinutes the resource is also held after the time (cleanup, turnaround), 0–1440. On a booking segment it overrides the resource’s default. Buffers must fit in working hours and can’t overlap blocks or other bookings.
metadatamapUp to 50 keys of your own (strings, keys up to 40 characters, values up to 500). Returned on every read and webhook. On update, an empty string removes a key.
Unarchive a resource
/v1/resources/{id}/unarchiveLets an archived resource take bookings again, and clears the resource_archived flag from its future bookings.
Send the business’s id in Tiempo-Account.
Path parameters
idstringrequiredThe object’s id.
Delete a resource
/v1/resources/{id}Only for a resource that was never booked, say one created by mistake; its schedules, overrides and blocks go with it. One with any bookings, past or future, or in an active series is refused (409 resource_in_use): archive it instead.
Send the business’s id in Tiempo-Account.
Path parameters
idstringrequiredThe object’s id.
Archive a resource
/v1/resources/{id}/archiveStops new bookings on the resource. Existing future bookings stay, flagged as conflicted with reason resource_archived so you can move them.
Send the business’s id in Tiempo-Account.
Path parameters
idstringrequiredThe object’s id.