Avoma API Documentation
This is the complete API documentation for connecting to the Avoma 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 Avoma: Manage Avoma meetings, notes, recordings, and conversation insights. Keep reading to get started.
Quickstart
Before you run your first Avoma 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 Avoma connection — create or choose one in Connections. Note its
connectionId.
Every Avoma action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/avoma/actions/{actionSlug}/runYou need a MindCloud API Key and a Avoma connection. Then call an action such as List Users:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/avoma/actions/list-users/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'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.
Authenticate with a MindCloud API Key plus a connectionId for your Avoma account. See Avoma API Authentication for the full flow and how to get your connection credentials.
Avoma actions
All 25 published actions for this Avoma version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Call
- POSTCreate Meeting Outcome
- POSTCreate Meeting Type
- DELETEDelete Meeting Outcome
- DELETEDelete Meeting Type
- GETGet Call
- GETGet Meeting
- GETGet Meeting Insights
- GETGet Meeting Outcome
- GETGet Meeting Segments
- GETGet Meeting Sentiments
- GETGet Meeting Type
- GETGet Recording
- GETGet Recording By UUID
- GETGet Transcription
- GETList Calls
- GETList Meeting Outcomes
- GETList Meeting Types
- GETList Meetings
- GETList Notes
- GETList Transcriptions
- GETList Users
- PUTUpdate Call
- PUTUpdate Meeting Outcome
- PUTUpdate Meeting Type
Related apps
More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.