Skip to main content
GET
Get paginated list of locations

Get All Locations

Retrieve a paginated list of your organization’s centers/locations. Home-address records for patients and staff are always excluded, so only real centers and offices are returned.

Headers

Query Parameters

  • page (optional): Page number (1-indexed). Default: 1. Minimum: 1
  • pageSize (optional): Number of items per page. Default: 25. Minimum: 1, Maximum: 100
  • type (optional): Filter by location type. When omitted, HOUSE locations are excluded and only real centers/offices are returned.
    • Available types: HOUSE, SCHOOL, TEMPORARY_LODGING, COMMUNITY, OFFICE, PLACE_OF_EMPLOYMENT, OTHER

Success Response (200)

Error Responses

400 - Validation Error

401 - Unauthorized

Examples

cURL Example

JavaScript Example

Authorizations

Authorization
string
header
required

API key authentication. Include your API key in the Authorization header as 'Bearer '

Query Parameters

page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
pageSize
integer
default:25

Number of items per page

Required range: 1 <= x <= 100
type
enum<string>

Filter by location type. When omitted, HOUSE locations are excluded and only real centers/offices are returned. Type of location. HOUSE locations back patient/staff home addresses and are never returned by the list locations endpoint.

Available options:
HOUSE,
SCHOOL,
TEMPORARY_LODGING,
COMMUNITY,
OFFICE,
PLACE_OF_EMPLOYMENT,
OTHER

Response

Successful response

data
object[]
required

Array of locations

pagination
object
required