TaskrouterEvent

List Event

GET
/v1/Workspaces/{WorkspaceSid}/Events

Authorization

accountSid_authToken
AuthorizationBasic <token>

In: header

Path Parameters

WorkspaceSid*string

The SID of the Workspace with the Events to read. Returns only the Events that pertain to the specified Workspace.

Match^WS[0-9a-fA-F]{32}$
Length34 <= length <= 34

Query Parameters

EndDate?string

Only include Events that occurred on or before this date, specified in GMT as an ISO 8601 date-time.

Formatdate-time
EventType?string

The type of Events to read. Returns only Events of the type specified.

Minutes?integer

The period of events to read in minutes. Returns only Events that occurred since this many minutes in the past. The default is 15 minutes. Task Attributes for Events occuring more 43,200 minutes ago will be redacted.

ReservationSid?string

The SID of the Reservation with the Events to read. Returns only Events that pertain to the specified Reservation.

Match^WR[0-9a-fA-F]{32}$
Length34 <= length <= 34
StartDate?string

Only include Events from on or after this date and time, specified in ISO 8601 format. Task Attributes for Events older than 30 days will be redacted.

Formatdate-time
TaskQueueSid?string

The SID of the TaskQueue with the Events to read. Returns only the Events that pertain to the specified TaskQueue.

Match^WQ[0-9a-fA-F]{32}$
Length34 <= length <= 34
TaskSid?string

The SID of the Task with the Events to read. Returns only the Events that pertain to the specified Task.

Match^WT[0-9a-fA-F]{32}$
Length34 <= length <= 34
WorkerSid?string

The SID of the Worker with the Events to read. Returns only the Events that pertain to the specified Worker.

Match^WK[0-9a-fA-F]{32}$
Length34 <= length <= 34
WorkflowSid?string

The SID of the Workflow with the Events to read. Returns only the Events that pertain to the specified Workflow.

Match^WW[0-9a-fA-F]{32}$
Length34 <= length <= 34
TaskChannel?string

The TaskChannel with the Events to read. Returns only the Events that pertain to the specified TaskChannel.

Sid?string

The SID of the Event resource to read.

Match^EV[0-9a-fA-F]{32}$
Length34 <= length <= 34
PageSize?integer

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Formatint64
Range1 <= value <= 1000
Page?integer

The page index. This value is simply for client state.

Range0 <= value
PageToken?string

The page token. This is provided by the API.

Response Body

application/json

curl -X GET "https://example.com/v1/Workspaces/stringstringstringstringstringstri/Events?EndDate=2008-01-03T00%3A00%3A00Z&EventType=reservation.created&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

{  "events": [    {      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",      "actor_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",      "actor_type": "workspace",      "actor_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",      "description": "Worker JustinWorker updated to Idle Activity",      "event_data": {        "worker_activity_name": "Offline",        "worker_activity_sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",        "worker_attributes": "{}",        "worker_name": "JustinWorker",        "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",        "worker_time_in_previous_activity": "26",        "worker_time_in_previous_activity_ms": "26123",        "workspace_name": "WorkspaceName",        "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"      },      "event_date": "2015-02-07T00:32:41Z",      "event_date_ms": 987654321111,      "event_type": "worker.activity",      "resource_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",      "resource_type": "worker",      "resource_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Workers/WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",      "sid": "EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",      "source": "twilio",      "source_ip_address": "1.2.3.4",      "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",      "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events/EVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"    }  ],  "meta": {    "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",    "key": "events",    "next_page_url": null,    "page": 0,    "page_size": 50,    "previous_page_url": null,    "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?TaskQueueSid=WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&StartDate=2008-01-02T00%3A00%3A00Z&EndDate=2008-01-03T00%3A00%3A00Z&WorkerSid=WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&EventType=reservation.created&TaskSid=WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&WorkflowSid=WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ReservationSid=WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0"  }}