Path parameters

• WorkspaceSid string Required

  The SID of the Workspace with the Workflow to read.

Query parameters

• FriendlyName string

  The friendly_name of the Workflow resources to read.

• PageSize integer

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

  Minimum value is 1, maximum value is 1000.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri)
    • page integer
    • page_size integer
    • previous_page_url string(uri)
    • url string(uri)
  • workflows array[object]
    Hide workflows attributes Show workflows attributes array[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}$.

    • assignment_callback_url string(uri) | null

      The URL that we call when a task managed by the Workflow is assigned to a Worker

    • configuration string | null

      A JSON string that contains the Workflow's configuration

    • date_created string(date-time) | null

      The RFC 2822 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The RFC 2822 date and time in GMT when the resource was last updated

    • document_content_type string | null

      The MIME type of the document

    • fallback_assignment_callback_url string(uri) | null

      The URL that we call when a call to the assignment_callback_url fails

    • friendly_name string | null

      The string that you assigned to describe the Workflow resource

    • links object(uri-map) | null

      The URLs of related resources

    • sid string | null

      The unique string that identifies the resource

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

    • task_reservation_timeout integer | null

      How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker

    • url string(uri) | null

      The absolute URL of the Workflow resource

    • workspace_sid string | null

      The SID of the Workspace that contains the Workflow

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