Vtiger CRM API Documentation

This is the complete API documentation for connecting to the Vtiger 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 Vtiger CRM: Connect Vtiger CRM to read and manage CRM records, module metadata, and tenant data through the Vtiger REST API. Keep reading to get started.

Quickstart

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

Every Vtiger CRM action uses the same URL pattern:

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

You need a MindCloud API Key and a Vtiger CRM connection. Then call an action such as Get Current User:

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

Vtiger CRM actions

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

• POSTCreate Account
• POSTCreate Contact
• POSTCreate Deal
• POSTCreate Invoice
• POSTCreate Lead
• POSTCreate Product
• POSTCreate Purchase Order
• POSTCreate Quote
• POSTCreate Record
• POSTCreate Sales Order
• POSTCreate Vendor
• DELETEDelete Record
• GETDescribe Accounts
• GETDescribe Contacts
• GETDescribe Deals
• GETDescribe Invoices
• GETDescribe Leads
• GETDescribe Module
• GETDescribe Products
• GETDescribe Purchase Orders
• GETDescribe Quotes
• GETDescribe Sales Orders
• GETDescribe Vendors
• GETGet Current User
• GETList Accounts
• GETList Contacts
• GETList Deals
• GETList Invoices
• GETList Leads
• GETList Modules
• GETList Products
• GETList Purchase Orders
• GETList Quotes
• GETList Sales Orders
• GETList Vendors
• GETQuery Records
• GETRetrieve Record
• PUTRevise Record

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