Skip to main content
GET
Provider directory summary (letter histogram, total, type counts)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

whereName
string

Filter by name (contains, case-insensitive).

Maximum string length: 200
Example:

"lobby"

whereLocation
string

Filter by location (contains, case-insensitive).

Maximum string length: 200
Example:

"lobby"

whereTypes
string[]

Filter by provider type (matches any of the given codes).

Example:
whereNameInitial
string[]

Filter by the name initial (A-Z, or # for anything else).

Example:
whereUnitIds
string<uuid>[]

Narrow providers linked to the requested unit ids.

Maximum array length: 250
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:
whereITIds
string<uuid>[]

Narrow providers linked to the requested technical installation ids.

Maximum array length: 250
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:
whereLabelIds
string<uuid>[]

Filter by linked label ids.

Maximum array length: 250
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:
whereArchived

When true, only archived providers; when false, only non-archived.

Example:

true

Response

Default Response

letters
object[]
required
totalCount
integer
required
Required range: 0 <= x <= 9007199254740991
typeCounts
object
required