task_events

GET /task_events/

Changed on

Mixin which allows the override of the filename being passed back to the user when the spreadsheet is downloaded.

Request

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

Query parameters

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.

event'create' | 'assign' | 'unassign' | 'reject' | 'accept' | 'unaccept' | 'transit' | 'activate' | 'complete' | 'fail' | 'cancel' | 'assignee_near' | 'assignee_away' | 'updated'

event

event__instring

event__in

field'' | 'state' | 'assignee_proximity'

field

format'json' | 'xlsx'
from_state'unassigned' | 'assigned' | 'accepted' | 'transit' | 'active' | 'completed' | 'failed' | 'cancelled' | 'away' | 'near'

from_state

from_state__instring

from_state__in

orderingstring

Which field to use when ordering the results.

page_sizeinteger

Number of results to return per page.

taskstring

task

task__accountstring

task__account

to_state'unassigned' | 'assigned' | 'accepted' | 'transit' | 'active' | 'completed' | 'failed' | 'cancelled' | 'away' | 'near'

to_state

to_state__instring

to_state__in

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
task_commandstring uri required
event'create' | 'assign' | 'unassign' | 'reject' | 'accept' | 'unaccept' | 'transit' | 'activate' | 'complete' | 'fail' | 'cancel' | 'assignee_near' | 'assignee_away' | 'updated' required
from_state'unassigned' | 'assigned' | 'accepted' | 'transit' | 'active' | 'completed' | 'failed' | 'cancelled' | 'away' | 'near' required
to_state'unassigned' | 'assigned' | 'accepted' | 'transit' | 'active' | 'completed' | 'failed' | 'cancelled' | 'away' | 'near' required
userstring uri required
notesstring

Event notes

assigneestring uri 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/xlsx; version=2.4.12 was changed to application/xlsx; version=2.4.13 for the response status

    • breaking

      the response property // became optional for the status (media type: application/json; version=2.4.12)

    • breaking

      the response property // became optional for the status (media type: application/xlsx; version=2.4.12)

    • 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

    • info

      added the optional write-only property items/task/contact_address to the response with the status (media type: application/json; version=2.4.12)

    • info

      added the optional write-only property items/task/contact_address to the response with the status (media type: application/xlsx; version=2.4.12)