List field value

GET /v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues

TODO: Resource-level docs

Path parameters

  • AssistantSid string Required

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

  • FieldTypeSid string Required

    The SID of the Field Type associated with the Field Value to read.

Query parameters

  • Language string

    The ISO language-country tag that specifies the language of the value. Currently supported tags: en-US

  • 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

  • OK

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

      • assistant_sid string | null

        The SID of the Assistant that is the parent of the FieldType 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_sid string | null

        The SID of the Field Type associated with the Field Value

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

      • language string | null

        The ISO language-country tag that identifies the language of the value

      • sid string | null

        The unique string that identifies the resource

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

      • synonym_of string | null

        The word for which the field value is a synonym of

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

      • url string(uri) | null

        The absolute URL of the FieldValue resource

      • value string | null

        The Field Value data

    • meta object
      Hide meta attributes Show meta attributes object
GET /v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues
curl \
 -X GET https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues \
 --user "username:password"
Response examples (200)
{
  "field_values": [
    {
      "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_sid": "string",
      "language": "string",
      "sid": "string",
      "synonym_of": "string",
      "url": "https://example.com",
      "value": "string"
    }
  ],
  "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"
  }
}
Response examples (200)
{
  "field_values": [
    {
      "account_sid": "string",
      "assistant_sid": "string",
      "date_created": "2024-05-04T09:42:00+00:00",
      "date_updated": "2024-05-04T09:42:00+00:00",
      "field_type_sid": "string",
      "language": "string",
      "sid": "string",
      "synonym_of": "string",
      "url": "https://example.com",
      "value": "string"
    }
  ],
  "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"
  }
}