client_roles

GET /client_roles/

Changed on

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Query parameters

accountstring

account

clientstring

client

created_at__datestring date
created_at__date_or_isnullstring date
created_at__gtstring datetime
created_at__gt_or_isnullstring datetime
created_at__gtestring datetime
created_at__gte_or_isnullstring datetime
created_at__ltstring datetime
created_at__lt_or_isnullstring datetime
created_at__ltestring datetime
created_at__lte_or_isnullstring datetime
cursorinteger

The pagination cursor value.

format'json' | 'xlsx'
is_activestring

is_active

is_managerstring

is_manager

page_sizeinteger

Number of results to return per page.

searchstring

A search term.

updated_at__datestring date
updated_at__date_or_isnullstring date
updated_at__gtstring datetime
updated_at__gt_or_isnullstring datetime
updated_at__gtestring datetime
updated_at__gte_or_isnullstring datetime
updated_at__ltstring datetime
updated_at__lt_or_isnullstring datetime
updated_at__ltestring datetime
updated_at__lte_or_isnullstring datetime
userstring

user

Response

idstring uuid required
urlstring uri required
accountstring uri required
clientstring uri required
userstring uri required
phonestring
is_managerboolean
is_activeboolean

Designates whether this Client Role should be treated as active.

created_atstring date-time required
updated_atstring date-time required

Changes

    • info

      media type application/json; version=2.4.12 was changed to application/json; version=2.4.13 for the response status

    • info

      media type application/xlsx; version=2.4.12 was changed to application/xlsx; version=2.4.13 for the response status

    • info

      media type application/json; version=2.4.11 was changed to application/json; version=2.4.12 for the response status

    • info

      media type application/xlsx; version=2.4.11 was changed to application/xlsx; version=2.4.12 for the response status