Fetch task

GET /v1/Workspaces/{WorkspaceSid}/Tasks/{Sid}

TODO: Resource-level docs

Path parameters

  • WorkspaceSid string Required

    The SID of the Workspace with the Task to fetch.

  • Sid string Required

    The SID of the Task resource to fetch.

Responses

  • OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • addons string | null

      An object that contains the addon data for all installed addons

    • age integer | null

      The number of seconds since the Task was created

    • assignment_status string | null

      The current status of the Task's assignment

      Values are pending, reserved, assigned, canceled, completed, or wrapping.

    • attributes string | null

      The JSON string with custom attributes of the work

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was last updated

    • priority integer | null

      Retrieve the list of all Tasks in the Workspace with the specified priority

    • reason string | null

      The reason the Task was canceled or completed

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WT[0-9a-fA-F]{32}$.

    • task_channel_sid string | null

      The SID of the TaskChannel

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^TC[0-9a-fA-F]{32}$.

    • The unique name of the TaskChannel

    • task_queue_entered_date string(date-time) | null

      The ISO 8601 date and time in GMT when the Task entered the TaskQueue.

    • The friendly name of the TaskQueue

    • task_queue_sid string | null

      The SID of the TaskQueue

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WQ[0-9a-fA-F]{32}$.

    • timeout integer | null

      The amount of time in seconds that the Task can live before being assigned

    • url string(uri) | null

      The absolute URL of the Task resource

    • The friendly name of the Workflow that is controlling the Task

    • workflow_sid string | null

      The SID of the Workflow that is controlling the Task

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WW[0-9a-fA-F]{32}$.

    • workspace_sid string | null

      The SID of the Workspace that contains the Task

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.

GET /v1/Workspaces/{WorkspaceSid}/Tasks/{Sid}
curl \
 -X GET https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Tasks/{Sid} \
 --user "username:password"
Response examples (200)
{
  "account_sid": "string",
  "addons": "string",
  "age": 42,
  "assignment_status": "pending",
  "attributes": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "links": {},
  "priority": 42,
  "reason": "string",
  "sid": "string",
  "task_channel_sid": "string",
  "task_channel_unique_name": "string",
  "task_queue_entered_date": "2023-05-04T09:42:00+00:00",
  "task_queue_friendly_name": "string",
  "task_queue_sid": "string",
  "timeout": 42,
  "url": "https://example.com",
  "workflow_friendly_name": "string",
  "workflow_sid": "string",
  "workspace_sid": "string"
}
Response examples (200)
{
  "account_sid": "string",
  "addons": "string",
  "age": 42,
  "assignment_status": "pending",
  "attributes": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "links": {},
  "priority": 42,
  "reason": "string",
  "sid": "string",
  "task_channel_sid": "string",
  "task_channel_unique_name": "string",
  "task_queue_entered_date": "2024-05-04T09:42:00+00:00",
  "task_queue_friendly_name": "string",
  "task_queue_sid": "string",
  "timeout": 42,
  "url": "https://example.com",
  "workflow_friendly_name": "string",
  "workflow_sid": "string",
  "workspace_sid": "string"
}