Vtiger API

10 endpoints for Vtiger, each at its own method and path, called with your API key. Open an endpoint for its inputs, examples and response.

Base URL: https://cotlet.dev/api/v1/vtiger
Connects with: Your own Vtiger CRM user (your role decides which contacts, deals and cases you see and change; an admin for settings, pipelines and SLA policies)
Integration page: Vtiger

Read (5)

Return data and change nothing in the account.

Vtiger Endpoints: Read
Endpoint	Description
GET /contacts	Contacts of your CRM with organization, lifecycle stage and owner; leads too when the Leads module is on.
GET /deals	Deals with amount, sales stage, pipeline, expected close date and owner.
GET /records/{record_id}/deal	One deal with its fields, related contact and journey tasks.
GET /cases	Support cases with status, priority, group, owner and contact.
GET /records/{record_id}/case	One case with its description, contact, SLA and current assignment.

Change the account. Calls marked Confirm wait for the user to approve them.

Vtiger Endpoints: Write
Endpoint	Description
POST /contacts Confirm	Create a contact with email, phone, organization and lifecycle stage.
POST /records/{record_id}/contact-to-deal/convert Confirm	Convert a lead into a deal, as the Convert button does.
PATCH /records/{record_id}/deal-stage Confirm	Move a deal to another sales stage or pipeline.
POST /cases Confirm	Open a support case for a contact, with or without an email to the customer.
PATCH /records/{record_id}/case Confirm	Set a case's group, owner, priority, status or SLA.