Skip to main content

List tenant locations with pagination

GET 

/locations

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.

Request​

Responses​

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.