CATS API Documentation

This is the complete API documentation for connecting to the CATS 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 CATS: Manage recruiting pipelines, candidates, jobs, and hiring workflows. Keep reading to get started.

Quickstart

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

Every CATS action uses the same URL pattern:

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

You need a MindCloud API Key and a CATS connection. Then call an action such as Filter Candidates:

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

CATS actions

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

• PUTChange Job Status
• PUTChange Pipeline Status
• POSTCreate Candidate
• POSTCreate Candidate Activity
• POSTCreate Company
• POSTCreate Contact
• POSTCreate Job
• POSTCreate Pipeline
• DELETEDelete Candidate
• DELETEDelete Company
• DELETEDelete Contact
• DELETEDelete Job
• DELETEDelete Pipeline
• GETFilter Candidates
• GETFilter Jobs
• GETFilter Pipelines
• GETGet Candidate
• GETGet Candidate Application
• GETGet Company
• GETGet Contact
• GETGet Job
• GETGet Job Application
• GETGet Pipeline
• GETGet Site
• GETList Applications By Candidate
• GETList Applications By Job
• GETList Candidate Activities
• GETList Candidates
• GETList Companies
• GETList Contacts
• GETList Job Statuses
• GETList Jobs
• GETList Pipelines
• GETList Pipelines By Candidate
• GETList Users
• GETSearch Candidates
• GETSearch Companies
• GETSearch Contacts
• GETSearch Jobs
• PUTUpdate Candidate
• PUTUpdate Company
• PUTUpdate Contact
• PUTUpdate Job
• PUTUpdate Pipeline
• PUTUpload Resume

Related apps

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

LinkedInClockifyConnecteamBambooHRTalentLMSCertifierZoho RecruitMemberVault