v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-056136556.2 KB
TaskrouterV1Event

get/v1/Workspaces/{WorkspaceSid}/Events

Path parameters

WorkspaceSidstring required

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

Query parameters

EndDatestring date-time

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

EventTypestring

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

Minutesinteger

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.

ReservationSidstring

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

StartDatestring date-time

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.

TaskQueueSidstring

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

TaskSidstring

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

WorkerSidstring

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

WorkflowSidstring

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

TaskChannelstring

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

Sidstring

The SID of the Event resource to read.

PageSizeinteger

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

Pageinteger

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

PageTokenstring

The page token. This is provided by the API.

Response

OK