ServiceSlotResponse

Response schema for service slots

data objectrequired

aggregated_slots object[]

Array [

countintegerrequired

end_atstring<date-time>required

end_at_tsinteger

Unix timestamp in seconds

objectstringrequired

String representing the object's type.

Possible values: [aggregated_slot]

start_atstring<date-time>required

start_at_tsinteger

Unix timestamp in seconds

time_zonestringrequired

IANA time zone name

]

provider_slots object[]

Array [

open object[]

Array [

end_atstring<date-time>required

end_at_tsintegerrequired

Unix timestamp in seconds

objectstringrequired

String representing the object's type.

Possible values: [slot]

start_atstring<date-time>required

start_at_tsintegerrequired

Unix timestamp in seconds

time_zonestringrequired

IANA time zone name

]

service_provider object

A service provider

created_atstring<date-time>required

When the service provider was created.

idstringrequired

Service Provider ID

Possible values: Value must match regular expression ^sp_\w{12}$

objectstringrequired

String representing the object's type.

Possible values: [service_provider]

provider objectrequired

A provider represents a staff member who can provide services to clients.

created_atstring<date-time>required

Time at which the object was created.

display_namestringrequired

The provider's display name.

first_namestringrequired

The provider's first name.

idstringrequired

Unique identifier for the object.

Possible values: Value must match regular expression ^prov_\w{12}$

last_namestringrequired

The provider's last name.

metadataobject

Set of key-value pairs attached to this provider. Maximum size is 16 KB.

objectstringrequired

String representing the object's type.

Possible values: [provider]

updated_atstring<date-time>required

Time at which the object was last updated.

service_idstringrequired

Service ID

Possible values: Value must match regular expression ^srv_\w{12}$

updated_atstring<date-time>required

When the service provider was last updated.

]

ServiceSlotResponse

{
  "data": {
    "aggregated_slots": [
      {
        "count": 1,
        "end_at": "2025-03-10T10:00:00Z",
        "end_at_ts": 1736464800,
        "object": "aggregated_slot",
        "start_at": "2025-03-10T09:00:00Z",
        "start_at_ts": 1736461200,
        "time_zone": "Etc/UTC"
      },
      {
        "count": 1,
        "end_at": "2025-03-10T12:00:00Z",
        "end_at_ts": 1736468400,
        "object": "aggregated_slot",
        "start_at": "2025-03-10T11:00:00Z",
        "start_at_ts": 1736464800,
        "time_zone": "Etc/UTC"
      }
    ],
    "provider_slots": [
      {
        "open": [
          {
            "end_at": "2025-03-10T10:00:00Z",
            "end_at_ts": 1736464800,
            "object": "slot",
            "start_at": "2025-03-10T09:00:00Z",
            "start_at_ts": 1736461200,
            "time_zone": "Etc/UTC"
          },
          {
            "end_at": "2025-03-10T12:00:00Z",
            "end_at_ts": 1736468400,
            "object": "slot",
            "start_at": "2025-03-10T11:00:00Z",
            "start_at_ts": 1736464800,
            "time_zone": "Etc/UTC"
          }
        ],
        "service_provider": {
          "created_at": "2025-02-19T17:36:36Z",
          "id": "sp_d025a96ac0c6",
          "object": "service_provider",
          "provider": {
            "created_at": "2017-09-12T12:34:55Z",
            "display_name": "John Smith",
            "first_name": "John",
            "id": "prov_d025a96ac0c6",
            "last_name": "Smith",
            "metadata": {
              "external_id": "123"
            },
            "object": "provider",
            "updated_at": "2017-09-13T10:11:12Z"
          },
          "service_id": "srv_d025a96ac0c6",
          "updated_at": "2025-02-19T17:36:36Z"
        }
      }
    ]
  }
}