tiempoAPI reference
API reference

Schedule overrides

Replace one resource’s hours for one local date. An empty list means not working that day.

Create a schedule override

POST/v1/schedule_overrides

Replaces a resource’s hours for one local date. One per resource per date.

Send the business’s id in Tiempo-Account.

Body parameters

  • resourcestringrequired

    A resource id.

  • datedaterequired

    A local date, YYYY-MM-DD.

  • intervalsarray of objectsrequired

    The hours for that date, { start, end, location? } in HH:mm. Empty means not working.

    • startstringrequired

      An ISO-8601 instant.

    • endstringrequired

      An ISO-8601 instant, after start.

    • locationstring

      A location id.

  • 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 schedule overrides

GET/v1/schedule_overrides

Send the business’s id in Tiempo-Account.

Query parameters

  • resourcestring

    Only those involving this resource. On the calendar, repeat it for several.

  • from_datedate

    From this local date (YYYY-MM-DD), inclusive.

  • to_datedate

    To this local date (YYYY-MM-DD), inclusive.

  • 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 schedule override

GET/v1/schedule_overrides/{id}

Send the business’s id in Tiempo-Account.

Path parameters

  • idstringrequired

    The object’s id.

Update a schedule override

POST/v1/schedule_overrides/{id}

Changes the hours or metadata for that date. The resource and date are fixed: to move an override, delete it and create another. Bookings the new hours don’t cover are flagged conflicted.

Send the business’s id in Tiempo-Account.

Path parameters

  • idstringrequired

    The object’s id.

Body parameters

  • intervalsarray of objects

    The hours for that date, { start, end, location? } in HH:mm. Empty means not working.

    • startstringrequired

      An ISO-8601 instant.

    • endstringrequired

      An ISO-8601 instant, after start.

    • locationstring

      A location id.

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

Delete a schedule override

DELETE/v1/schedule_overrides/{id}

Send the business’s id in Tiempo-Account.

Path parameters

  • idstringrequired

    The object’s id.