Providers

List providers

get

Retrieve a paginated list of providers with optional filtering

Required scopes

This endpoint requires the following scopes:

Authorizations

apiKeyAuth

X-API-KeystringRequired

API key for authentication (format: sdh_...)

Path parameters

tenantstringRequired

Provider organization tenant identifier

Example: acme-corp

Query parameters

providerIdsstringOptional

searchstringOptional

locationIdsstringOptional

serviceIdsstringOptional

disciplinesstringOptional

includeInactivestring · enumOptionalPossible values:

pagestringOptionalPattern: ^\d+$

pageSizestringOptionalPattern: ^\d+$

limitstringOptionalPattern: ^\d+$

offsetstringOptionalPattern: ^\d+$

Responses

200

Successfully retrieved items

application/json

401

Unauthorized - invalid or missing authentication

403

Forbidden - insufficient permissions

get

/v1/provider/{tenant}/providers

HTTPcURLJavaScriptPython

GET /v1/provider/{tenant}/providers HTTP/1.1
Host: api.seconddoor.app
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "text",
      "lastName": "text",
      "displayName": "text",
      "prefix": "text",
      "postfix": "text",
      "credentials": "text",
      "type": "text",
      "gender": "text",
      "birthDate": "text",
      "photo": "https://example.com",
      "timezone": "text",
      "virtualOnly": true,
      "selfSchedulingEnabled": true,
      "locationServicePresetsEnabled": true,
      "disciplines": [
        "text"
      ],
      "active": true,
      "note": "text",
      "user": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "email": "[email protected]",
        "firstName": "text",
        "lastName": "text"
      },
      "locations": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        }
      ],
      "services": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        }
      ],
      "identifiers": [
        {
          "system": "text",
          "value": "text"
        }
      ],
      "createdAt": "2026-02-05T19:30:37.662Z",
      "updatedAt": "2026-02-05T19:30:37.662Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "page": 1,
      "pageSize": 1,
      "totalPages": 1,
      "hasNextPage": true,
      "hasPreviousPage": true
    }
  }
}

Create a new provider

post

Create a new provider for the provider organization

Required scopes

This endpoint requires the following scopes:

Authorizations

apiKeyAuth

X-API-KeystringRequired

API key for authentication (format: sdh_...)

Path parameters

tenantstringRequired

Provider organization tenant identifier

Example: acme-corp

Body

application/json

Request body for creating a provider

firstNamestring · min: 1 · max: 100Required

Provider first name

lastNamestring · min: 1 · max: 100Required

Provider last name

displayNamestring · min: 1Optional

prefixstringOptional

postfixstringOptional

credentialsstringOptional

typestringOptional

genderstringOptional

birthDatestringOptional

photostring · uriOptional

timezonestringOptional

virtualOnlybooleanOptional

selfSchedulingEnabledbooleanOptional

locationServicePresetsEnabledbooleanOptional

disciplinesstring[]Optional

activebooleanOptional

notestringOptional

userIdstring · uuidOptional

locationIdsstring · uuid[]Optional

serviceIdsstring · uuid[]Optional

Responses

201

Item created successfully

application/json

400

Invalid request body

401

Unauthorized - invalid or missing authentication

403

Forbidden - insufficient permissions

post

/v1/provider/{tenant}/providers

HTTPcURLJavaScriptPython

POST /v1/provider/{tenant}/providers HTTP/1.1
Host: api.seconddoor.app
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 552

{
  "firstName": "text",
  "lastName": "text",
  "displayName": "text",
  "prefix": "text",
  "postfix": "text",
  "credentials": "text",
  "type": "text",
  "gender": "text",
  "birthDate": "text",
  "photo": "https://example.com",
  "timezone": "text",
  "virtualOnly": true,
  "selfSchedulingEnabled": true,
  "locationServicePresetsEnabled": true,
  "disciplines": [
    "text"
  ],
  "active": true,
  "note": "text",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "locationIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "serviceIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "identifiers": [
    {
      "system": "text",
      "value": "text"
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "firstName": "text",
  "lastName": "text",
  "displayName": "text",
  "prefix": "text",
  "postfix": "text",
  "credentials": "text",
  "type": "text",
  "gender": "text",
  "birthDate": "text",
  "photo": "https://example.com",
  "timezone": "text",
  "virtualOnly": true,
  "selfSchedulingEnabled": true,
  "locationServicePresetsEnabled": true,
  "disciplines": [
    "text"
  ],
  "active": true,
  "note": "text",
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "firstName": "text",
    "lastName": "text"
  },
  "locations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ],
  "services": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ],
  "identifiers": [
    {
      "system": "text",
      "value": "text"
    }
  ],
  "createdAt": "2026-02-05T19:30:37.662Z",
  "updatedAt": "2026-02-05T19:30:37.662Z"
}

Get provider by ID

get

Retrieve detailed information about a specific provider

Required scopes

This endpoint requires the following scopes:

Authorizations

apiKeyAuth

X-API-KeystringRequired

API key for authentication (format: sdh_...)

Path parameters

tenantstringRequired

Provider organization tenant identifier

Example: acme-corp

Responses

200

Successfully retrieved item

application/json

401

Unauthorized - invalid or missing authentication

403

Forbidden - insufficient permissions

404

Location not found

get

/v1/provider/{tenant}/providers/{id}

HTTPcURLJavaScriptPython

GET /v1/provider/{tenant}/providers/{id} HTTP/1.1
Host: api.seconddoor.app
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "firstName": "text",
  "lastName": "text",
  "displayName": "text",
  "prefix": "text",
  "postfix": "text",
  "credentials": "text",
  "type": "text",
  "gender": "text",
  "birthDate": "text",
  "photo": "https://example.com",
  "timezone": "text",
  "virtualOnly": true,
  "selfSchedulingEnabled": true,
  "locationServicePresetsEnabled": true,
  "disciplines": [
    "text"
  ],
  "active": true,
  "note": "text",
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "firstName": "text",
    "lastName": "text"
  },
  "locations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ],
  "services": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ],
  "identifiers": [
    {
      "system": "text",
      "value": "text"
    }
  ],
  "createdAt": "2026-02-05T19:30:37.662Z",
  "updatedAt": "2026-02-05T19:30:37.662Z"
}

Delete a provider

delete

Soft delete a provider (marks as inactive). Only available to direct provider organization users.

Required scopes

This endpoint requires the following scopes:

Authorizations

apiKeyAuth

X-API-KeystringRequired

API key for authentication (format: sdh_...)

Path parameters

tenantstringRequired

Provider organization tenant identifier

Example: acme-corp

Responses

204

Item deleted successfully

401

Unauthorized - invalid or missing authentication

403

Forbidden - insufficient permissions

404

Location not found

delete

/v1/provider/{tenant}/providers/{id}

HTTPcURLJavaScriptPython

DELETE /v1/provider/{tenant}/providers/{id} HTTP/1.1
Host: api.seconddoor.app
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Update a provider

patch

Update an existing provider (partial update supported). Integration partners require both PROVIDERS_WRITE and INTEGRATIONS_WRITE scopes.

Required scopes

This endpoint requires the following scopes:

Authorizations

apiKeyAuth

X-API-KeystringRequired

API key for authentication (format: sdh_...)

Path parameters

tenantstringRequired

Provider organization tenant identifier

Example: acme-corp

Body

application/json

Request body for updating a provider

firstNamestring · min: 1 · max: 100Optional

lastNamestring · min: 1 · max: 100Optional

displayNamestring · min: 1Optional

prefixstringOptional

postfixstringOptional

credentialsstringOptional

typestringOptional

genderstringOptional

birthDatestringOptional

photostring · uriOptional

timezonestringOptional

virtualOnlybooleanOptional

selfSchedulingEnabledbooleanOptional

locationServicePresetsEnabledbooleanOptional

disciplinesstring[]Optional

activebooleanOptional

notestringOptional

userIdstring · uuidOptional

locationIdsstring · uuid[]Optional

serviceIdsstring · uuid[]Optional

Responses

200

Item updated successfully

application/json

400

Invalid request body

401

Unauthorized - invalid or missing authentication

403

Forbidden - insufficient permissions

404

Location not found

patch

/v1/provider/{tenant}/providers/{id}

HTTPcURLJavaScriptPython

PATCH /v1/provider/{tenant}/providers/{id} HTTP/1.1
Host: api.seconddoor.app
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 552

{
  "firstName": "text",
  "lastName": "text",
  "displayName": "text",
  "prefix": "text",
  "postfix": "text",
  "credentials": "text",
  "type": "text",
  "gender": "text",
  "birthDate": "text",
  "photo": "https://example.com",
  "timezone": "text",
  "virtualOnly": true,
  "selfSchedulingEnabled": true,
  "locationServicePresetsEnabled": true,
  "disciplines": [
    "text"
  ],
  "active": true,
  "note": "text",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "locationIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "serviceIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "identifiers": [
    {
      "system": "text",
      "value": "text"
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "firstName": "text",
  "lastName": "text",
  "displayName": "text",
  "prefix": "text",
  "postfix": "text",
  "credentials": "text",
  "type": "text",
  "gender": "text",
  "birthDate": "text",
  "photo": "https://example.com",
  "timezone": "text",
  "virtualOnly": true,
  "selfSchedulingEnabled": true,
  "locationServicePresetsEnabled": true,
  "disciplines": [
    "text"
  ],
  "active": true,
  "note": "text",
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "firstName": "text",
    "lastName": "text"
  },
  "locations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ],
  "services": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    }
  ],
  "identifiers": [
    {
      "system": "text",
      "value": "text"
    }
  ],
  "createdAt": "2026-02-05T19:30:37.662Z",
  "updatedAt": "2026-02-05T19:30:37.662Z"
}