List field

GET /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields

TODO: Resource-level docs

Path parameters

  • AssistantSid string Required

    The SID of the Assistant that is the parent of the Task associated with the resources to read.

  • TaskSid string Required

    The SID of the Task resource associated with the Field resources to read.

Query parameters

  • 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
    • fields array[object]
      Hide fields attributes Show fields attributes
      • 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}$.

      • assistant_sid string | null

        The SID of the Assistant that is the parent of the Task associated with the resource

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

      • 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

      • field_type string | null

        The Field Type of the field

      • sid string | null

        The unique string that identifies the resource

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

      • task_sid string | null

        The SID of the Task resource associated with this Field

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

      • unique_name string | null

        An application-defined string that uniquely identifies the resource

      • url string(uri) | null

        The absolute URL of the Field resource

    • meta object
      Hide meta attributes Show meta attributes
GET /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields 
curl \
 -X GET https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields \
 --user "username:password"
Response examples (200) 
{
  "fields": [
    {
      "account_sid": "string",
      "assistant_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "field_type": "string",
      "sid": "string",
      "task_sid": "string",
      "unique_name": "string",
      "url": "https://example.com"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}