Retrieve a list of Add-ons currently available to be installed

GET /v1/AvailableAddOns
Account sid auth token

Retrieve a list of Add-ons currently available to be installed.

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.

  • 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
    • 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
    • available_add_ons array[object]
      Hide available_add_ons attributes Show available_add_ons attributes object
      • sid string | null

        The unique string that we created to identify the AvailableAddOn resource.

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

      • friendly_name string | null

        The string that you assigned to describe the resource.

      • description string | null

        A short description of the Add-on's functionality.

      • pricing_type string | null

        How customers are charged for using this Add-on.

      • configuration_schema object | null

        The JSON object with the configuration that must be provided when installing a given Add-on.

      • url string(uri) | null

        The absolute URL of the resource.

      • links object(uri-map) | null

        The URLs of related resources.

    • 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/AvailableAddOns 
curl \
 --request GET 'https://marketplace.twilio.com/v1/AvailableAddOns' \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "key": "available_add_ons",
    "url": "https://marketplace.twilio.com/v1/AvailableAddOns?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://marketplace.twilio.com/v1/AvailableAddOns?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "available_add_ons": [
    {
      "sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "links": {
        "extensions": "https://marketplace.twilio.com/v1/AvailableAddOns/XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Extensions"
      },
      "description": "Automatic Transcription and Keyword Extract...",
      "pricing_type": "per minute",
      "friendly_name": "VoiceBase High Accuracy Transcription",
      "configuration_schema": {
        "type": "object",
        "required": [
          "bad_words"
        ],
        "properties": {
          "bad_words": {
            "type": "boolean"
          }
        }
      }
    }
  ]
}
{
  "meta": {
    "key": "available_add_ons",
    "url": "https://marketplace.twilio.com/v1/AvailableAddOns?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://marketplace.twilio.com/v1/AvailableAddOns?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "available_add_ons": []
}