List Notes for Client

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

Lists all Notes for the specified client.

Requires: ViewAll on Clients.

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.

Date UpdatedDate

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

Date UpdatedDate

sortDesc query boolean

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

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

authorCode query string

Filter by author (user) code

Filter by author (user) code

search query string

Search across note text (minimum 3 characters)

Search across note text (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