latestOpenAPI 3.1.02026-08-194237902.5 MB
563848e0ecc0
Locations
Search locations by name
Returns a paginated list of locations whose name matches the supplied query term. Results are suitable for autocomplete dropdowns on the Groups list page. Requires the READ_LOCATION permission. Returns an empty result set (200) when the location-search feature is disabled for this environment.
get/locations/search
Query parameters
pageinteger
Page number (0-based)
qstring required
Search term matched against location name (substring, case-insensitive). Min 2 chars, max 128 chars.
sizeinteger
Page size (max 50)
Headers
tenant-idstring required
Tenant ID for the requesting organization.
Response
Paginated list of matching locations
Example response
{
"data": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Main Street Clinic"
}
]
}