Ortto API Documentation
This is the complete API documentation for connecting to the Ortto 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 Ortto: Manage customer data, audiences, and marketing activity in Ortto. Keep reading to get started.
Quickstart
Before you run your first Ortto request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Ortto connection — create or choose one in Connections. Note its
connectionId.
Every Ortto action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/ortto/latest/actions/{actionSlug}You need a MindCloud API Key and a Ortto connection. Then call an action such as Export Campaign Data:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/ortto/latest/actions/export-campaign-data" \
--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 Ortto account that should run the action. MindCloud stores and refreshes the Ortto 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.
Ortto actions
All 30 published actions for this Ortto version. Each page documents the endpoint, arguments, and response controls.
- PUTArchive Accounts
- DELETEArchive Custom Activity
- PUTArchive People
- POSTCreate Account Custom Field
- POSTCreate Custom Activity Definition
- POSTCreate Custom Activity Event
- POSTCreate Person Custom Field
- DELETEDelete Accounts
- DELETEDelete Custom Field
- DELETEDelete People
- GETExport Campaign Data
- GETGet Accounts
- GETGet Email Suppression List
- GETGet People
- GETGet People Subscription Statuses
- GETList Account Custom Fields
- GETList Audiences
- GETList Person Custom Fields
- GETList Sent Campaigns
- GETList Tags
- PUTModify Custom Activity Definition
- PUTRemove Email Suppression List Entries
- PUTRestore Accounts
- PUTRestore People
- PUTSubscribe Audience Members
- PUTUnsubscribe Audience Members
- PUTUpdate Account Custom Field
- PUTUpdate Person Custom Field
- POSTUpsert Accounts
- POSTUpsert People
Related apps
More Marketing apps on the Universal API, behind the same REST shape. Or browse all apps.