Tarvent API Documentation

This is the complete API documentation for connecting to the Tarvent 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 Tarvent: Manage audiences, campaigns, journeys, and transactional email in Tarvent. Keep reading to get started.

Quickstart

Before you run your first Tarvent 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 Tarvent connection — create or choose one in Connections. Note its connectionId.

Every Tarvent action uses the same URL pattern:

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

You need a MindCloud API Key and a Tarvent connection. Then call an action such as Get Account:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/tarvent/latest/actions/get-account" \
  --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 Tarvent account that should run the action. MindCloud stores and refreshes the Tarvent 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.

Tarvent actions

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

• GETGet Account
• GETGet Account API Key
• GETGet Account Invoice
• GETGet Monthly Growth Stats
• GETList Account API Keys
• GETList Account Invoices
• GETList Account Plan Stats
• GETList Audiences
• GETList Campaigns
• GETList Custom Reports
• GETList Exports
• GETList Integration Partners
• GETList Journeys
• GETList Plans
• GETList Suppression Filters
• GETList Templates
• GETList Transactions
• GETList User Notifications
• GETList Webhooks
• GETSearch Account Entities

Related apps

More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.

GmailSlackDiscordTwilioMicrosoft TeamsCircletl;dvClickSend SMS