Locations

List locations

get

Retrieve a paginated list of locations 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

locationIdsstringOptional

searchstringOptional

statestring · max: 2Optional

citystringOptional

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}/locations

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "displayName": "text",
      "description": "text",
      "virtual": true,
      "selfSchedulingEnabled": true,
      "active": true,
      "website": "https://example.com",
      "address": {
        "line": "text",
        "city": "text",
        "state": "text",
        "postalCode": "text",
        "country": "text"
      },
      "email": "[email protected]",
      "phone": "text",
      "providerOrganization": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "createdAt": "2026-02-05T19:30:37.520Z",
      "updatedAt": "2026-02-05T19:30:37.520Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "page": 1,
      "pageSize": 1,
      "totalPages": 1,
      "hasNextPage": true,
      "hasPreviousPage": true
    }
  }
}

Create a new location

post

Create a new location 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 location

namestring · min: 1 · max: 250Required

Location name

displayNamestring · min: 1Optional

descriptionstring · max: 350Optional

virtualbooleanOptional

selfSchedulingEnabledbooleanOptional

activebooleanOptional

websitestring · uriOptional

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}/locations

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "displayName": "text",
  "description": "text",
  "virtual": true,
  "selfSchedulingEnabled": true,
  "active": true,
  "website": "https://example.com"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "displayName": "text",
  "description": "text",
  "virtual": true,
  "selfSchedulingEnabled": true,
  "active": true,
  "website": "https://example.com",
  "address": {
    "line": "text",
    "city": "text",
    "state": "text",
    "postalCode": "text",
    "country": "text"
  },
  "email": "[email protected]",
  "phone": "text",
  "providerOrganization": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "createdAt": "2026-02-05T19:30:37.520Z",
  "updatedAt": "2026-02-05T19:30:37.520Z"
}

Get location by ID

get

Retrieve detailed information about a specific location

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}/locations/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "displayName": "text",
  "description": "text",
  "virtual": true,
  "selfSchedulingEnabled": true,
  "active": true,
  "website": "https://example.com",
  "address": {
    "line": "text",
    "city": "text",
    "state": "text",
    "postalCode": "text",
    "country": "text"
  },
  "email": "[email protected]",
  "phone": "text",
  "providerOrganization": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "createdAt": "2026-02-05T19:30:37.520Z",
  "updatedAt": "2026-02-05T19:30:37.520Z"
}

Delete a location

delete

Soft delete a location (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}/locations/{id}

HTTPcURLJavaScriptPython

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

No content

Update a location

patch

Update an existing location (partial update supported). Integration partners require both LOCATIONS_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 location

namestring · min: 1 · max: 250Optional

displayNamestring · min: 1Optional

descriptionstring · max: 350Optional

virtualbooleanOptional

selfSchedulingEnabledbooleanOptional

activebooleanOptional

websitestring · uriOptional

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}/locations/{id}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "displayName": "text",
  "description": "text",
  "virtual": true,
  "selfSchedulingEnabled": true,
  "active": true,
  "website": "https://example.com"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "displayName": "text",
  "description": "text",
  "virtual": true,
  "selfSchedulingEnabled": true,
  "active": true,
  "website": "https://example.com",
  "address": {
    "line": "text",
    "city": "text",
    "state": "text",
    "postalCode": "text",
    "country": "text"
  },
  "email": "[email protected]",
  "phone": "text",
  "providerOrganization": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "createdAt": "2026-02-05T19:30:37.520Z",
  "updatedAt": "2026-02-05T19:30:37.520Z"
}