account_roles

GET /account_roles/

Changed on

Request

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

Query parameters

accountstring

account

activated_at__datestring date
activated_at__date_or_isnullstring date
activated_at__gtstring datetime
activated_at__gt_or_isnullstring datetime
activated_at__gtestring datetime
activated_at__gte_or_isnullstring datetime
activated_at__ltstring datetime
activated_at__lt_or_isnullstring datetime
activated_at__ltestring datetime
activated_at__lte_or_isnullstring datetime
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.

deleted_at__datestring date
deleted_at__date_or_isnullstring date
deleted_at__gtstring datetime
deleted_at__gt_or_isnullstring datetime
deleted_at__gtestring datetime
deleted_at__gte_or_isnullstring datetime
deleted_at__ltstring datetime
deleted_at__lt_or_isnullstring datetime
deleted_at__ltestring datetime
deleted_at__lte_or_isnullstring datetime
display_namestring

display_name

format'json' | 'xml'
is_activeboolean
is_integrationstring

is_integration

is_managerstring

is_manager

is_workerstring

is_worker

orderingstring

Which field to use when ordering the results.

page_sizeinteger

Number of results to return per page.

searchstring

A search term.

state'inactive' | 'active' | 'deleted'

state

state__instring
state__in_or_isnullstring
state__not_instring
state__not_in_or_isnullstring
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
userstring uri
state'inactive' | 'active' | 'deleted' required
emailstring email required
display_namestring nullable
phonestring
vehicle_registration_numberstring
vehicle_profile'bike' | 'bus' | 'car' | 'foot' | 'scooter' | 'small_truck' | 'truck'
vehicle_capacityinteger[] nullable
vehicle_speed_factorstring decimal
vehicle_service_time_factorstring decimal
signature_imagestring uri required
is_managerboolean
is_workerboolean
is_integrationboolean
is_activeboolean required
is_on_dutyboolean required
show_unassignedboolean
last_time_locationstring uri required
activated_atstring date-time required
deleted_atstring date-time required
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/xml; version=2.4.12 was changed to application/xml; 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/xml; version=2.4.11 was changed to application/xml; version=2.4.12 for the response status