task_commands

GET /task_commands/

Changed on

Request

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

Query parameters

accepted_at__datestring date
accepted_at__date_or_isnullstring date
accepted_at__gtstring datetime
accepted_at__gt_or_isnullstring datetime
accepted_at__gtestring datetime
accepted_at__gte_or_isnullstring datetime
accepted_at__ltstring datetime
accepted_at__lt_or_isnullstring datetime
accepted_at__ltestring datetime
accepted_at__lte_or_isnullstring datetime
action'update' | 'reassign' | 'assign' | 'accept' | 'unaccept' | 'reject' | 'unassign' | 'transit' | 'activate' | 'complete' | 'fail' | 'cancel' | 'assignee_near' | 'assignee_away'

action

assigneestring

assignee

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'
page_sizeinteger

Number of results to return per page.

rejected_at__datestring date
rejected_at__date_or_isnullstring date
rejected_at__gtstring datetime
rejected_at__gt_or_isnullstring datetime
rejected_at__gtestring datetime
rejected_at__gte_or_isnullstring datetime
rejected_at__ltstring datetime
rejected_at__lt_or_isnullstring datetime
rejected_at__ltestring datetime
rejected_at__lte_or_isnullstring datetime
state'pending' | 'accepted' | 'rejected'

state

taskstring

task

task__accountstring

task__account

timestring

time

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
taskstring uri required
external_idstring nullable
timestring date-time required
action'update' | 'reassign' | 'assign' | 'accept' | 'unaccept' | 'reject' | 'unassign' | 'transit' | 'activate' | 'complete' | 'fail' | 'cancel' | 'assignee_near' | 'assignee_away' required
userstring uri required
notesstring

Task command notes

assigneestring uri nullable
state'pending' | 'accepted' | 'rejected'
error_messagestring
accepted_atstring date-time nullable
rejected_atstring date-time nullable
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