Marketplace API overview for users
The Marketplace API provides resources for users to browse, install, and manage Listings. Listing Partners can use Marketplace API resources to retrieve and update Listings, and to manually report customer usage.
All relative URLs in the Marketplace API reference documentation use the following base URL:
https://marketplace.twilio.com/v1
The API is served over HTTPS. To ensure data privacy, unencrypted HTTP isn't supported. All responses are in JSON format.
To authenticate requests to the Twilio APIs, Twilio supports HTTP Basic authentication. Use your API key as the username and your API key secret as the password. You can create an API key either in the Twilio Console or using the API.
Note: Twilio doesn't recommend using your Account SID and Auth Token in production. For local testing, you can use your Account SID as the username and your Auth token as the password. You can find your Account SID and Auth Token in the Twilio Console.
Learn more about Twilio API authentication.
The following table lists some common scenarios along with associated HTTP response codes, Twilio Debugger notifications, and messages that the Marketplace API returns.
| HTTP response code | Debugger notification | Description |
|---|---|---|
| 404 | Warning | The Add-on isn't installed on the customer account or no Listing is found with the Installation SID. |
| 403 | Warning | The Account Sid in the API request doesn't match with the Partner Account Sid attached to the Add-on. |
| 403 | Warning | The Add-on isn't set up to accept Manual Usage Reporting. |
| 403 | Warning | The Add-on isn't in one of the Marketing Preview, Private Beta, or Active state. |
| 400 | Warning | Quantity is either null, empty, or 0. |
| 500 | Error | Error received while generating a billing event. |
| 202 | N/A | The request is successful, and a billing event is generated. |
The Marketplace API comprises the following resources for Marketplace Listing users:
| Resource | Description |
|---|---|
| AvailableAddOns | Get the details of a specific Listing or view a list of all available Listings. |
| AvailableAddOn Extensions | Get an Extension or view a list of Extensions associated with an Available Add-on Listing. |
| InstalledAddOns | Install, configure, and manage installed Add-on Listings for an Account. |
| InstalledAddOns Extensions | Get an Extension, view a list of Extensions, or update an Extension associated with an Installed Add-on Listing. |
| Recording AddOnResults | Get a Result, view a list of Results, or delete Results associated with a specific Recording. |
| Recording AddOnResults Payloads | Get a Payload, view a list of Payloads, or delete Payloads associated with a specific Recording Add-on Result. |
| Recording AddOnResults Payloads Data | Get or the Data associated with a specific Recording Add-on Result Payload. |
| IncomingPhoneNumber AssignedAddOns | Get or list AddOns assigned to a phone number. Assign or unassign AddOns for a phone number. |
| IncomingPhoneNumber AssignedAddOns Extensions | Get an Extension or view a list of Extensions associated with an assigned Add-on Listing of a Twilio phone number. |