Solutions keyboard_arrow_down keyboard_arrow_up
Our Solutions
Ontraport's solutions work together to give you everything you need to run your business in one centralized, easy-to-use platform.
Resources keyboard_arrow_down keyboard_arrow_up
Find free content on the latest marketing strategies, using Ontraport in your business, and finding the right software.
Visit the blog
University Pricing Chat
Use Ontraport's API
Last updated on: April 13, 2023

Ontraport’s API offers a simple interface with JSON-formatted responses. You can use it to manage contacts, process transactions, add and remove tags and automation maps, and much more.

Before you dive into programming an integration with Ontraport, check out our comprehensive list of existing integrations to see if yours has already been built.

Using Ontraport’s API

For detailed information, visit our official Ontraport API documentation. Here’s how to get started:

  1. Follow these steps to obtain an Ontraport API key and App ID.
  2. Visit our interactive API documentation.
  3. Enter the API key and App ID at the top of the page to begin creating and testing API calls.

To find the available objects in your account:

  1. Click the Objects section.
  2. Open GET/objects/meta.
  3. Under ParametersFormat select By Name.
  4. Click Try It Out!

The response will include all of the objects you can access. For example, within the “data” array shown in the image below, the first string, “Contact” is the object name, and the “id”: 0 attribute is the objectID for the contact object (contacts database).

There are many more objects you can access through the API. You can see the full list, along with their object type ID and permissions, here.

Have you created an integration that we don’t know about yet? Email us about it.

Related university lessons
Gateway setup
You need at least one payment gateway in your Ontraport account so you can process transactions. Watch this video to learn how to set up your payment gateway.
Privacy + data security
When you’re using private data about any contacts on your list via merge fields or element database connections, it’s important to keep that info under wraps. Keep your contacts’ info private and secure with the tips from this lesson.
What is a web application
Learn exactly what makes a web application different from a website – so you can start dreaming of the possibilities for your business!
Divider Text
Related support articles
Integration overview
Use Ontraport's API
 Pro tips
Tip #1: For more resources, you can access our PHP client library here or subscribe to notifications of API changes through our API RSS feed.
Tip #2: Our support team does not offer assistance with learning how to program using our API, and they do not write code. For experienced developers, we are happy to help with specific questions about code you have written that is producing an error. Please include the code in a plain text file and attach it to an email addressed to Include a description of the error you are receiving.
Tip #3: API keys are extremely sensitive information because they enable access to real data in your account. To ensure the information remains secure, please do not share APP ID and API Key information with anyone, including Ontraport Support (we will never ask for it).
Live events
© Ontraport 2024
PCI DSS, Level 1
Privacy Shield Certified