Ontraport API Documentation

This is the complete API documentation for connecting to the Ontraport API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Ontraport: Manage contacts, campaigns, payments, and messaging in Ontraport. Keep reading to get started.

Quickstart

Before you run your first Ontraport request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Ontraport connection — create or choose one in Connections. Note its connectionId.

Every Ontraport action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/ontraport/latest/actions/{actionSlug}

You need a MindCloud API Key and a Ontraport connection. Then call an action such as List Contacts:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/ontraport/latest/actions/list-contacts" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Ontraport account that should run the action. MindCloud stores and refreshes the Ontraport credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Ontraport actions

All 24 published actions for this Ontraport version. Each page documents the endpoint, arguments, and response controls.

• GETList Contacts
• GETList Messages
• GETList Products
• GETList Tags
• GETList Tasks
• GETList Transactions
• GETRetrieve Contact Collection Info
• GETRetrieve Contact Object Meta
• GETRetrieve Message Collection Info
• GETRetrieve Message Meta
• GETRetrieve Product Collection Info
• GETRetrieve Product Object Meta
• GETRetrieve Single Transaction
• GETRetrieve Specific Contact
• GETRetrieve Specific Message
• GETRetrieve Specific Product
• GETRetrieve Specific Tag
• GETRetrieve Specific Task
• GETRetrieve Tag Collection Info
• GETRetrieve Tag Object Meta
• GETRetrieve Task Collection Info
• GETRetrieve Task Object Meta
• GETRetrieve Transaction Collection Info
• GETRetrieve Transaction Object Meta

Related apps

More Sales & CRM apps on the Universal API, behind the same REST shape. Or browse all apps.

HubSpotPipedriveGoogle TasksGoogle ContactsTodoistZoho CRMFollow Up BossClose