tiempoAPI reference
API reference

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

POST/v1/resources

Adds 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

  • namestringrequired

    Shown in your dashboard; not to customers.

  • typestringrequired

    Your label for grouping, for example worker, room or court.

  • capacityinteger

    How many bookings it can hold at once. Defaults to 1.

  • timezonestring

    IANA name, for example Europe/London.

  • default_locationstring

    Where the resource works when a schedule interval doesn’t say.

  • buffer_before_minutesinteger

    Minutes 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_minutesinteger

    Minutes 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.

  • metadatamap

    Up 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

GET/v1/resources

Send the business’s id in Tiempo-Account.

Query parameters

  • typestring

    Only this type. For events, an exact type or a prefix like booking.*.

  • statusstring

    Only objects with this status.

  • default_locationstring

    Only resources based at this location.

  • limitinteger

    1 to 100. Defaults to 20.

  • starting_afterstring

    An object id from the previous page; returns the page after it.

  • ending_beforestring

    An object id; returns the page before it.

  • metadata[key]string

    Only objects whose metadata has this key and value. Repeat for several.

Retrieve a resource

GET/v1/resources/{id}

Send the business’s id in Tiempo-Account.

Path parameters

  • idstringrequired

    The object’s id.

Update a resource

POST/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

  • idstringrequired

    The object’s id.

Body parameters

  • namestring

    Shown in your dashboard; not to customers.

  • capacityinteger

    How many bookings it can hold at once. Defaults to 1.

  • timezonestring

    IANA name, for example Europe/London.

  • default_locationstring

    Where the resource works when a schedule interval doesn’t say.

  • buffer_before_minutesinteger

    Minutes 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_minutesinteger

    Minutes 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.

  • metadatamap

    Up 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

POST/v1/resources/{id}/unarchive

Lets 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

  • idstringrequired

    The object’s id.

Delete a resource

DELETE/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

  • idstringrequired

    The object’s id.

Archive a resource

POST/v1/resources/{id}/archive

Stops 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

  • idstringrequired

    The object’s id.