ServiceProvidersResponse

Response schema for a list of service providers

data object[]required

Array [

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.

]

ServiceProvidersResponse

{
  "data": [
    {
      "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"
    }
  ]
}