latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Practitioner

List locations in a practitioner's relationship graph

Returns a paginated list of group_practitioner_locations (GPL) associations for the practitioner, each including relationship context such as the group, tenant group location, and any linked location-network (TGLPN) records. Use this when you need location data with relationship context; for a simpler list without relationship graph data, use GET /practitioners/{practitionerId}/locations instead. {id} is the certifyPractitionerId. This endpoint previously returned unstructured raw relationship data and is now a typed, paginated response (breaking change as of 2026-07-01); the operationId retains its legacy plural form for OpenAPI stability even though the underlying method is getPractitionerLocationRelationships. Terminated associations are included; none of the available filters (certifyGroupId, networkId, locationSearch) filter by termination status.

get/practitioners/{id}/relationships/locations

Path parameters

idstring required

Certify practitioner id. Maps to the OV entityId (certify_practitioner_id).

Query parameters

certifyGroupIdstring

Filter by certify group id. Only GPLs whose group resolves to this id are returned. Omit to include all groups.

locationSearchstring

Filter by location name (case-insensitive substring match against the resolved location name). Omit/blank to include all locations.

networkIdstring

Filter by network id. Only GPLs that have a matching TGLPN row for this network id are returned (EXISTS semantics — GPL rows are never duplicated). The tenantGroupLocationPractitionerNetworks array on each item is also filtered to this network when set. Omit to include all networks.

pageinteger

Page number (0-based), for offset-based pagination. Default: 0.

sizeinteger

Page size (clamped to max 100). Default: 50.

Headers

tenant-idstring required

Tenant ID

Response

Paginated GPL location associations successfully retrieved.

totalCountinteger

Total number of matching GPL records (across all pages).