Retrieves a list of all Custom Operators for an Account.

GET /v2/Operators/Custom

Retrieves a list of all Custom Operators for an Account.

Query parameters

  • Availability string

    Returns Custom Operators with the provided availability type. Possible values: internal, beta, public, retired.

    Values are internal, beta, public, or retired.

  • LanguageCode string

    Returns Custom Operators that support the provided language code.

  • PageSize integer(int64)

    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.

  • Page integer

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

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • X-Rate-Limit-Limit string
    • X-Rate-Limit-Remaining string
    • X-Rate-Limit-Config string
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • operators array[object]
      Hide operators attributes Show operators attributes object
      • account_sid string | null

        The unique SID identifier of the Account the Custom Operator belongs to.

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

      • sid string | null

        A 34 character string that uniquely identifies this Custom Operator.

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

      • friendly_name string | null

        A human-readable name of this resource, up to 64 characters.

      • description string | null

        A human-readable description of this resource, longer than the friendly name.

      • author string | null

        The creator of the Custom Operator. Custom Operators can only be created by a Twilio Account.

      • operator_type string | null

        Operator Type for this Operator. References an existing Operator Type resource.

      • version integer

        Numeric Custom Operator version. Incremented with each update on the resource, used to ensure integrity when updating the Custom Operator.

        Default value is 0.

      • availability string

        Custom Operator availability status. Possible values: internal, beta, public, retired.

        Values are internal, beta, public, or retired.

      • config

        Operator configuration, following the schema defined by the Operator Type. Only available on Operators created by the Account.

      • date_created string(date-time) | null

        The date that this Custom Operator was created, given in ISO 8601 format.

      • date_updated string(date-time) | null

        The date that this Custom Operator was updated, given in ISO 8601 format.

      • url string(uri) | null

        The URL of this resource.

    • 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 /v2/Operators/Custom
curl \
 --request GET 'https://intelligence.twilio.com/v2/Operators/Custom' \
 --user "username:password"
Response examples (200)
{
  "meta": {
    "key": "operators",
    "url": "https://intelligence.twilio.com/v2/Operators/Custom?LanguageCode=en&Availability=public&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://intelligence.twilio.com/v2/Operators/Custom?LanguageCode=en&Availability=public&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "operators": [
    {
      "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://intelligence.twilio.com/v2/Operators/Custom/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "config": {
        "configuration": {
          "field": "value"
        }
      },
      "version": 1,
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "description": "New Operator",
      "availability": "public",
      "date_created": "2010-08-31T20:36:28Z",
      "date_updated": "2010-08-31T20:36:28Z",
      "friendly_name": "My New Operator",
      "operator_type": "operator-type-name"
    }
  ]
}
{
  "meta": {
    "key": "operators",
    "url": "https://intelligence.twilio.com/v2/Operators/Custom?LanguageCode=en&Availability=public&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://intelligence.twilio.com/v2/Operators/Custom?LanguageCode=en&Availability=public&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "operators": []
}