Skip to main content
GET
List the provider contacts (name/provider filters)

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
default:1
Required range: 0 < x <= 9007199254740991
pageSize
integer
default:50
Required range: 0 < x <= 1000
countOnly
boolean

When true, answers totalCount with an empty data: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter.

Example:

true

extend
enum<string>[]

Extend options (JSON-encoded array, e.g. ?extend=["category"]):

  • "actions-info": Adds actions { canBeUpdated, canBeDeleted } per row.
Available options:
actions-info
orderBy
object[]

Case-insensitive partial match on the contact name.

Maximum string length: 200
Example:

"lobby"

whereProviderIds
string<uuid>[]

Filter by one or more provider (provider) 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:
whereProviderTypes
string[]

Keep only the contacts of a provider carrying at least one of these provider types.

Example:
whereHasEmail

When true, only the contacts carrying an email - the ones an assignment can actually notify.

Example:

true

Response

Default Response

data
object[]
required
totalCount
integer
required
Required range: 0 <= x <= 9007199254740991
pagination
object
required