Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Locations

List tenant locations with pagination

Returns a paginated list of location records scoped to the tenant identified by the required tenant-id header.

When to use: Use this operation to browse or enumerate locations for a tenant. For a single known location use GET /locations/{id} instead.

Preconditions: The tenant-id header is required; omitting it will result in a 400. Pagination is offset-based: supply page (0-based, defaults to 0) and size (items per page, defaults to 2 — this default is applied consistently across every OperationalValue list endpoint on the platform). No filter query parameters are currently exposed beyond page/size.

get/locations

Query parameters

pageinteger

Page number for offset based pagination (0-based index). Defaults to 0 if not specified.

sizeinteger

Number of items per page in offset based pagination. Defaults to 2 if not specified.

Headers

tenant-idstring

Response

A paginated envelope (PagedResponse) containing a data array of location objects and a totalCount field. The array may be empty if no locations exist for the tenant.

totalCountinteger

Total number of records matching the request, across all pages.

identifiersSearchedinteger

Count of identifiers submitted for a bulk-identifier search (e.g. bulk NPI search). Omitted/null for standard (non-bulk) list requests.

matchedCountinteger

Count of submitted identifiers that matched a record. Omitted/null for standard (non-bulk) list requests.

notFoundCountinteger

Count of submitted identifiers that did not match any record. Omitted/null for standard (non-bulk) list requests.

unmatchedIdentifiersstring[]

Submitted identifiers that did not match any record. Omitted/null for standard (non-bulk) list requests.

Example response

{
  "totalCount": 1,
  "identifiersSearched": 2,
  "matchedCount": 1,
  "notFoundCount": 1,
  "unmatchedIdentifiers": [
    "9999999999"
  ]
}