List Contacts for Client

GET /tenants/{tenant}/clients/{client}/clientcontact

Lists all Contacts for the specified client.

Requires: ViewAll on ClientContacts.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

client* path string
offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

sortBy query enum

Field to sort by. Valid values depend on the resource.

Name Role

Field to sort by. Valid values depend on the resource.

Name Role

sortDesc query boolean

Sort in descending order (true) or ascending order (false, default)

Sort in descending order (true) or ascending order (false, default)

type query string

Filter by contact type

Filter by contact type

role query string

Filter by contact role

Filter by contact role

search query string

Search across contact details: name, email, code (minimum 3 characters)

Search across contact details: name, email, code (minimum 3 characters)

Responses

401 Unauthorized – Invalid or missing API key
403 Forbidden – the caller lacks the permissions this endpoint requires; the detail lists every one missing
application/problem+json