List all assistants

GET /v1/Assistants

list assistants

Query parameters

  • Page integer

    The page index. This value is simply for client state.

    Minimum value is 0.

  • 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.

  • PageToken string

    The page token. This is provided by the API.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • assistants array[object]
      Hide assistants attributes Show assistants attributes object
      • account_sid string Required

        The SID of the Account that created the Assistant resource.

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

      • customer_ai object Required

        The Personalization and Perception Engine settings.

      • id string Required

        The Assistant ID.

        Format should match the following pattern: ^aia_asst_.+$.

      • model string Required

        The default model used by the assistant.

      • name string Required

        The name of the assistant.

      • owner string Required

        The owner/company of the assistant.

      • url string

        The url of the assistant resource.

      • personality_prompt string Required

        The personality prompt to be used for assistant.

      • date_created string(date-time) Required

        The date and time in GMT when the Assistant was created specified in ISO 8601 format.

      • date_updated string(date-time) Required

        The date and time in GMT when the Assistant was last updated specified in ISO 8601 format.

    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri) | null
      • page integer
      • page_size integer
      • previous_page_url string(uri) | null
      • url string(uri)
GET /v1/Assistants
curl \
 --request GET 'https://assistants.twilio.com/v1/Assistants' \
 --user "username:password"
Response examples (200)
{
  "assistants": [
    {
      "account_sid": "string",
      "customer_ai": {},
      "id": "string",
      "model": "string",
      "name": "string",
      "owner": "string",
      "url": "string",
      "personality_prompt": "string",
      "date_created": "2025-05-04T09:42:00Z",
      "date_updated": "2025-05-04T09:42:00Z"
    }
  ],
  "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"
  }
}