Kylas CRM API Documentation

This is the complete API documentation for connecting to the Kylas CRM 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 Kylas CRM: Manage contacts, tasks, meetings, users, notes, pipelines, and CRM configuration in Kylas. Keep reading to get started.

Quickstart

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

Every Kylas CRM action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/kylasCRM/actions/{actionSlug}/run

You need a MindCloud API Key and a Kylas CRM connection. Then call an action such as Check Lead Duplicates:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/kylasCRM/actions/check-lead-duplicates/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 Kylas CRM account. See Kylas CRM API Authentication for the full flow and how to get your connection credentials.

Kylas CRM actions

All 32 published actions for this Kylas CRM version. Each page documents the endpoint, arguments, and response controls.

• POSTAdd Currencies
• GETCheck Lead Duplicates
• POSTCreate Contact
• POSTCreate Lead
• DELETEDelete Contact
• DELETEDelete Lead
• GETGet Contact
• GETGet Contact Layout
• GETGet Lead
• GETGet Lead Layout
• GETGet Task Create Layout
• GETGet User
• GETList Active Currencies
• GETList Contacts
• GETList Fields
• GETList Tasks
• GETList Teams
• GETList Users
• GETLookup Contacts
• GETLookup Deal Pipelines
• GETLookup Deals
• GETLookup Lead Pipelines
• GETLookup Leads
• GETLookup Teams
• GETLookup Users
• GETSearch Contacts
• GETSearch Deals
• GETSearch Leads
• GETSearch Pipelines
• GETSearch Users
• PUTUpdate Contact
• PUTUpdate Lead

Related apps

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

PipedriveGoogle TasksGoogle ContactsTodoistZoho CRMFollow Up BossCloseDubsado