Help Center

| Submit or View Help Requests | Developer Docs |

View desktop instructions
View mobile app instructions API Explained for Partners

The API is organized around REST. Our API has predictable, resource-oriented URLs, accepts form-ended or JSON-encoded request bodies, returns XML-encoded or JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

To use the API, you will first need to enable API access, then retrieve your API credentials (Account SID and Auth Token) when they appear on the API Access screen. To reach this screen, follow the steps below.

  1. From the left navigation bar, select ellipsis-v-solid.svg [Menu] → Settings.

    • Alternatively, for Creator accounts, in the upper-right corner, select user-circle-solid.svg [User profile] → Settings.

  2. Under the Technical section, select API Access.

  3. What you plan to do via API will affect which set of credentials you retrieve.

    • If you want to do anything beyond retrieving information (like creating action inquiries), you should receive the Account SID and the Auth Token.

    • If you only want to retrieve information from via API, you should retrieve the Read-Only Account SID and Read-Only Auth Token.

Note: We have provided a list of IP address ranges that you will need to allowlist. Ensure that you allowlist the entire range, as you may accidentally be preventing's API from communicating with your system if you do not.

  • You have access to more resources compared to FTP and postbacks.

  • You can POST and PUT data into's system that is unrelated to actions or action inquiries (e.g., updating your media properties).

  • You have access to all developer documentation of the API.

    • To log in, use the same username and password as you use to log into the web app.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.