naftiko: 1.0.0-alpha2
info:
label: Twilio - Taskrouter — Workspaces
description: 'Twilio - Taskrouter — Workspaces. 60 operations. Lead operation: Workspaces. Self-contained Naftiko capability
covering one Twilio business surface.'
tags:
- Twilio
- Workspaces
created: '2026-05-19'
modified: '2026-05-19'
binds:
- namespace: env
keys:
TWILIO_API_KEY: TWILIO_API_KEY
capability:
consumes:
- type: http
namespace: task-router-workspaces
baseUri: https://taskrouter.twilio.com
description: Twilio - Taskrouter — Workspaces business capability. Self-contained, no shared references.
resources:
- name: v1-Workspaces
path: /v1/Workspaces
operations:
- name: listworkspace
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: FriendlyName
in: query
type: string
description: The `friendly_name` of the Workspace resources to read. For example `Customer Support` or `2014 Election
Campaign`.
- name: PageSize
in: query
type: integer
description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
- name: Page
in: query
type: integer
description: The page index. This value is simply for client state.
- name: PageToken
in: query
type: string
description: The page token. This is provided by the API.
- name: createworkspace
method: POST
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-Workspaces-Sid
path: /v1/Workspaces/{Sid}
operations:
- name: fetchworkspace
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Sid
in: path
type: string
description: The SID of the Workspace resource to fetch.
required: true
- name: updateworkspace
method: POST
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Sid
in: path
type: string
description: The SID of the Workspace resource to update.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: deleteworkspace
method: DELETE
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Sid
in: path
type: string
description: The SID of the Workspace resource to delete.
required: true
- name: v1-Workspaces-WorkspaceSid-Activities
path: /v1/Workspaces/{WorkspaceSid}/Activities
operations:
- name: listactivity
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the Activity resources to read.
required: true
- name: FriendlyName
in: query
type: string
description: The `friendly_name` of the Activity resources to read.
- name: Available
in: query
type: string
description: Whether return only Activity resources that are available or unavailable. A value of `true` returns
only available activities. Values of '1' or `yes` also indic
- name: PageSize
in: query
type: integer
description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
- name: Page
in: query
type: integer
description: The page index. This value is simply for client state.
- name: PageToken
in: query
type: string
description: The page token. This is provided by the API.
- name: createactivity
method: POST
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace that the new Activity belongs to.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-Workspaces-WorkspaceSid-Activities-Sid
path: /v1/Workspaces/{WorkspaceSid}/Activities/{Sid}
operations:
- name: fetchactivity
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the Activity resources to fetch.
required: true
- name: Sid
in: path
type: string
description: The SID of the Activity resource to fetch.
required: true
- name: updateactivity
method: POST
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the Activity resources to update.
required: true
- name: Sid
in: path
type: string
description: The SID of the Activity resource to update.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: deleteactivity
method: DELETE
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the Activity resources to delete.
required: true
- name: Sid
in: path
type: string
description: The SID of the Activity resource to delete.
required: true
- name: v1-Workspaces-WorkspaceSid-CumulativeStatistics
path: /v1/Workspaces/{WorkspaceSid}/CumulativeStatistics
operations:
- name: fetchworkspacecumulativestatistics
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace to fetch.
required: true
- name: EndDate
in: query
type: string
description: Only include usage that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
date-time.
- name: Minutes
in: query
type: integer
description: Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful
for displaying statistics for the last 15 minutes, 240 mi
- name: StartDate
in: query
type: string
description: Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
- name: TaskChannel
in: query
type: string
description: Only calculate cumulative statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`,
such as `voice`, `sms`, or `default`.
- name: SplitByWaitTime
in: query
type: string
description: A comma separated list of values that describes the thresholds, in seconds, to calculate statistics
on. For each threshold specified, the number of Tasks cancel
- name: v1-Workspaces-WorkspaceSid-Events
path: /v1/Workspaces/{WorkspaceSid}/Events
operations:
- name: listevent
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the Events to read. Returns only the Events that pertain to the specified
Workspace.
required: true
- name: EndDate
in: query
type: string
description: Only include Events that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
date-time.
- name: EventType
in: query
type: string
description: The type of Events to read. Returns only Events of the type specified.
- name: Minutes
in: query
type: integer
description: 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
- name: ReservationSid
in: query
type: string
description: The SID of the Reservation with the Events to read. Returns only Events that pertain to the specified
Reservation.
- name: StartDate
in: query
type: string
description: Only include Events from on or after this date and time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format. Task Attributes for Events olde
- name: TaskQueueSid
in: query
type: string
description: The SID of the TaskQueue with the Events to read. Returns only the Events that pertain to the specified
TaskQueue.
- name: TaskSid
in: query
type: string
description: The SID of the Task with the Events to read. Returns only the Events that pertain to the specified
Task.
- name: WorkerSid
in: query
type: string
description: The SID of the Worker with the Events to read. Returns only the Events that pertain to the specified
Worker.
- name: WorkflowSid
in: query
type: string
description: The SID of the Workflow with the Events to read. Returns only the Events that pertain to the specified
Workflow.
- name: TaskChannel
in: query
type: string
description: The TaskChannel with the Events to read. Returns only the Events that pertain to the specified TaskChannel.
- name: Sid
in: query
type: string
description: The SID of the Event resource to read.
- name: PageSize
in: query
type: integer
description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
- name: Page
in: query
type: integer
description: The page index. This value is simply for client state.
- name: PageToken
in: query
type: string
description: The page token. This is provided by the API.
- name: v1-Workspaces-WorkspaceSid-Events-Sid
path: /v1/Workspaces/{WorkspaceSid}/Events/{Sid}
operations:
- name: fetchevent
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the Event to fetch.
required: true
- name: Sid
in: path
type: string
description: The SID of the Event resource to fetch.
required: true
- name: v1-Workspaces-WorkspaceSid-RealTimeStatistics
path: /v1/Workspaces/{WorkspaceSid}/RealTimeStatistics
operations:
- name: fetchworkspacerealtimestatistics
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace to fetch.
required: true
- name: TaskChannel
in: query
type: string
description: Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`,
such as `voice`, `sms`, or `default`.
- name: v1-Workspaces-WorkspaceSid-Statistics
path: /v1/Workspaces/{WorkspaceSid}/Statistics
operations:
- name: fetchworkspacestatistics
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace to fetch.
required: true
- name: Minutes
in: query
type: integer
description: Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful
for displaying statistics for the last 15 minutes, 240 mi
- name: StartDate
in: query
type: string
description: Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
- name: EndDate
in: query
type: string
description: Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
date-time.
- name: TaskChannel
in: query
type: string
description: Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such
as `voice`, `sms`, or `default`.
- name: SplitByWaitTime
in: query
type: string
description: A comma separated list of values that describes the thresholds, in seconds, to calculate statistics
on. For each threshold specified, the number of Tasks cancel
- name: v1-Workspaces-WorkspaceSid-TaskChannels
path: /v1/Workspaces/{WorkspaceSid}/TaskChannels
operations:
- name: listtaskchannel
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the Task Channel to read.
required: true
- name: PageSize
in: query
type: integer
description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
- name: Page
in: query
type: integer
description: The page index. This value is simply for client state.
- name: PageToken
in: query
type: string
description: The page token. This is provided by the API.
- name: createtaskchannel
method: POST
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace that the new Task Channel belongs to.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-Workspaces-WorkspaceSid-TaskChannels-Sid
path: /v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid}
operations:
- name: fetchtaskchannel
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the Task Channel to fetch.
required: true
- name: Sid
in: path
type: string
description: The SID of the Task Channel resource to fetch.
required: true
- name: updatetaskchannel
method: POST
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the Task Channel to update.
required: true
- name: Sid
in: path
type: string
description: The SID of the Task Channel resource to update.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: deletetaskchannel
method: DELETE
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the Task Channel to delete.
required: true
- name: Sid
in: path
type: string
description: The SID of the Task Channel resource to delete.
required: true
- name: v1-Workspaces-WorkspaceSid-TaskQueues
path: /v1/Workspaces/{WorkspaceSid}/TaskQueues
operations:
- name: listtaskqueue
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the TaskQueue to read.
required: true
- name: FriendlyName
in: query
type: string
description: The `friendly_name` of the TaskQueue resources to read.
- name: EvaluateWorkerAttributes
in: query
type: string
description: The attributes of the Workers to read. Returns the TaskQueues with Workers that match the attributes
specified in this parameter.
- name: WorkerSid
in: query
type: string
description: The SID of the Worker with the TaskQueue resources to read.
- name: Ordering
in: query
type: string
description: Sorting parameter for TaskQueues
- name: PageSize
in: query
type: integer
description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
- name: Page
in: query
type: integer
description: The page index. This value is simply for client state.
- name: PageToken
in: query
type: string
description: The page token. This is provided by the API.
- name: createtaskqueue
method: POST
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace that the new TaskQueue belongs to.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-Workspaces-WorkspaceSid-TaskQueues-Statistics
path: /v1/Workspaces/{WorkspaceSid}/TaskQueues/Statistics
operations:
- name: listtaskqueuesstatistics
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the TaskQueues to read.
required: true
- name: EndDate
in: query
type: string
description: Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
date-time.
- name: FriendlyName
in: query
type: string
description: The `friendly_name` of the TaskQueue statistics to read.
- name: Minutes
in: query
type: integer
description: Only calculate statistics since this many minutes in the past. The default is 15 minutes.
- name: StartDate
in: query
type: string
description: Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
- name: TaskChannel
in: query
type: string
description: Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such
as `voice`, `sms`, or `default`.
- name: SplitByWaitTime
in: query
type: string
description: A comma separated list of values that describes the thresholds, in seconds, to calculate statistics
on. For each threshold specified, the number of Tasks cancel
- name: PageSize
in: query
type: integer
description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
- name: Page
in: query
type: integer
description: The page index. This value is simply for client state.
- name: PageToken
in: query
type: string
description: The page token. This is provided by the API.
- name: v1-Workspaces-WorkspaceSid-TaskQueues-Sid
path: /v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid}
operations:
- name: fetchtaskqueue
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the TaskQueue to fetch.
required: true
- name: Sid
in: path
type: string
description: The SID of the TaskQueue resource to fetch.
required: true
- name: updatetaskqueue
method: POST
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the TaskQueue to update.
required: true
- name: Sid
in: path
type: string
description: The SID of the TaskQueue resource to update.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: deletetaskqueue
method: DELETE
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the TaskQueue to delete.
required: true
- name: Sid
in: path
type: string
description: The SID of the TaskQueue resource to delete.
required: true
- name: v1-Workspaces-WorkspaceSid-TaskQueues-TaskQueueSid-CumulativeStatistics
path: /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/CumulativeStatistics
operations:
- name: fetchtaskqueuecumulativestatistics
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the TaskQueue to fetch.
required: true
- name: TaskQueueSid
in: path
type: string
description: The SID of the TaskQueue for which to fetch statistics.
required: true
- name: EndDate
in: query
type: string
description: Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
date-time.
- name: Minutes
in: query
type: integer
description: Only calculate statistics since this many minutes in the past. The default is 15 minutes.
- name: StartDate
in: query
type: string
description: Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
- name: TaskChannel
in: query
type: string
description: Only calculate cumulative statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`,
such as `voice`, `sms`, or `default`.
- name: SplitByWaitTime
in: query
type: string
description: A comma separated list of values that describes the thresholds, in seconds, to calculate statistics
on. For each threshold specified, the number of Tasks cancel
- name: v1-Workspaces-WorkspaceSid-TaskQueues-TaskQueueSid-RealTimeStatistics
path: /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/RealTimeStatistics
operations:
- name: fetchtaskqueuerealtimestatistics
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the TaskQueue to fetch.
required: true
- name: TaskQueueSid
in: path
type: string
description: The SID of the TaskQueue for which to fetch statistics.
required: true
- name: TaskChannel
in: query
type: string
description: The TaskChannel for which to fetch statistics. Can be the TaskChannel's SID or its `unique_name`, such
as `voice`, `sms`, or `default`.
- name: v1-Workspaces-WorkspaceSid-TaskQueues-TaskQueueSid-Statistics
path: /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/Statistics
operations:
- name: fetchtaskqueuestatistics
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the TaskQueue to fetch.
required: true
- name: TaskQueueSid
in: path
type: string
description: The SID of the TaskQueue for which to fetch statistics.
required: true
- name: EndDate
in: query
type: string
description: Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
date-time.
- name: Minutes
in: query
type: integer
description: Only calculate statistics since this many minutes in the past. The default is 15 minutes.
- name: StartDate
in: query
type: string
description: Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
- name: TaskChannel
in: query
type: string
description: 'Only calculate real-time and cumulative statistics for the specified TaskChannel. Can be the TaskChannel''s
SID or its `unique_name`, such as `voice`, `sms`, or '
- name: SplitByWaitTime
in: query
type: string
description: A comma separated list of values that describes the thresholds, in seconds, to calculate statistics
on. For each threshold specified, the number of Tasks cancel
- name: v1-Workspaces-WorkspaceSid-Tasks
path: /v1/Workspaces/{WorkspaceSid}/Tasks
operations:
- name: listtask
method: GET
description: ''
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: WorkspaceSid
in: path
type: string
description: The SID of the Workspace with the Tasks to read.
required: true
- name: Priority
in: query
type: integer
description: The priority value of the Tasks to read. Returns the list of all Tasks in the Workspace with the specified
priority.
- name: AssignmentStatus
in: query
type: array
description: 'The `assignment_status` of the Tasks you want to read. Can be: `pending`, `reserved`, `assigned`,
`canceled`, `wrapping`, or `completed`. Returns all Tasks in t'
- name: WorkflowSid
in: query
type: string
description: The SID of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified
by this SID.
- name: WorkflowName
in: query
type: string
description: The friendly name of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow
identified by this friendly name.
- name: TaskQueueSid
in: query
type: string
description: The SID of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified
by this SID.
- name: TaskQueueName
in: query
type: string
description: The `friendly_name` of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue
identified by this friendly name.
- name: EvaluateTaskAttributes
in: query
type: string
description: The attributes of the Tasks to read. Returns the Tasks that match the attributes specified in this
parameter.
- name: Ordering
in: query
type: string
description: 'How to order the returned Task resources. By default, Tasks are sorted by ascending DateC
# --- truncated at 32 KB (121 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/twilio/refs/heads/main/capabilities/task-router-workspaces.yaml