Articles in this section
Rest API Manual
Feature Availability
You can trigger a certain number of API calls per day/user based on the Edition. For more details, click here.
Introduction
The Vtiger REST API is a developer-friendly interface that enables seamless interaction between your Vtiger CRM and external systems such as mobile apps, websites, ERP tools, or automation platforms. It supports common web standards like HTTP and JSON, making it easy to use for both simple and complex integrations.
With the REST API, you can securely perform a wide range of operations—such as creating, retrieving, updating, deleting CRM records, syncing data, managing documents and files, executing workflows, tagging, and interacting with related modules.
To test and understand API behavior before building your own integration, Vtiger provides a Postman Collection that contains all supported endpoints.
Benefits of Using REST API in Vtiger
The following are the benefits of using REST APIs in Vtiger:
- Flexible Integrations: Easily connect Vtiger with external applications that don’t have built-in integrations.
- Automation: Automate repetitive tasks like lead creation, record updates, or campaign tracking.
- Scalability: Build scalable applications that interact with Vtiger CRM.
- Customization: Extend Vtiger functionality for unique business requirements.
- Time-Saving: Retrieve or update multiple records efficiently.
Key Terminology
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Getting Started with Vtiger API
Endpoint
Each Vtiger instance has a unique API endpoint. You’ll use this as the base URL for all API requests
API Endpoint Format:
|
|
- Replace your_instance with your Vtiger instance name
- Replace odx with od1, od2, or od3 based on your instance URL
Authentication
Authentication is done using HTTP Basic Auth.
- Username: Your CRM login email.
- Access Key: Found in the My Preferences section in Vtiger.
Follow these steps to get your Access key and Username:
- Log in to Vtiger CRM
- Click the User Menu.
- Select My Preference. The My Preference page opens.
- Copy the following information:
- Username: The login username for the CRM account
- Access Key: A unique API key
The Access Key acts like a password for API operations.
Using Postman for API Testing
Follow these steps to test Vtiger REST APIs using Postman:
- Install Postman from https://www.postman.com/downloads if you haven't already.
- Create a new request and set the request URL to your Vtiger endpoint (e.g., https://your_instance.odx.vtiger.com/restapi/v1/vtiger/default).
- Choose the HTTP method – either GET to fetch data or POST to send/update data.
- Go to the Authorization tab and set the type to Basic Authentication. Enter your Vtiger username and access key.
- If it's a POST request, switch to the Body tab and then enter your request payload.
- Click Send to execute the request.
- Review the response JSON in the output section to validate the API behavior.
API Response Format
Sample Success Response
|
|
Sample Failure Response
|
|
- HTTP 200 = Success
- HTTP 400/500 = Failure or error in request
Record ID Format
Record IDs in the REST API use the format:
|
|
Example: 4x2063 – where 4 is the module ID for Contacts, and 2063 is the record ID.
Postman Collection of APIs
You can use all the APIs below using the Postman collection. Use this link to access them.
Me
Authentication can be confirmed using this API before using any other operation. Response to this API can come in handy when the user-reference-id is required.
|
|
Response
|
|
ListTypes
You can get details about the module accessible to users through this API.
|
|
Response
|
|
Describe
The Metadata of the module provides information about record permissions, blocks, and field configuration for performing further operations.
|
|
Response
|
|
Create
This API enables you to create a single entity record. You are expected to send all the mandatory field values along with the optional fields for successful record creation. (Use Describe API to know more about the field mandatory configuration).
|
|
Response
|
|
Note: Most entity records expect the Assigned To (assigne_user_id) field value to be set. This value can be set to user_record_id obtained through Me API.
Retrieve
You can pull a piece of specific record information using this API.
|
|
Response
|
|
Decrypt
Use this API when you want to extract the value of a sensitive field of a record.
|
|
Response
|
|
Update
- When you intend to update specific fields of existing records, you can use this or the Revise API.
- Note: This API expects all the mandatory fields to be stated as part of the element parameter.
|
|
Response
|
|
Revise
This is similar to the Update API but relaxes the constraint of re-stating the mandatory fields, but expects target fields that need to be updated.
|
|
Response
|
|
Delete
Delete existing records through this API.
|
|
Response
|
|
Query
Retrieve one or more records matching filtering field conditions.
|
|
Response
|
|
Note:
- Queries will be enforced with an implicit maximum limit of 100 per fetch.
- Joins are not supported across different modules.
Sync
When you need to fetch records that changed their state from the last known time, you can use this API.
|
Parameter
|
Response
|
|
Note: A maximum of 200 records are returned within the array.
Convert Lead
Use this API to achieve lead conversion.
|
|
Response
|
|
Note: You cannot link the lead to an existing Opportunity.
Related Types
What relationship a module has with others can be obtained through this API.
|
|
Response
|
|
Retrieve Related
When you need related records of a target, use this API to retrieve a record.
|
|
Response
|
|
Query Related
Fetch related records matching search criteria using this API.
|
|
Response
|
|
Add Related
Establish a relationship between the two records.
|
|
Response
|
|
Delete Related
When you are looking to break the existing relationship between two records, you can use this API.
|
|
Response
|
|
Reopen
Reopen the closed record if permitted.
|
|
Response
|
|
Picklist Dependency
You can get a dependency between picklist fields. For example, you want to know all the details of the pipeline and stage dependencies in your Deals module so you can configure your CRM to map them.
|
|
Response
|
|
Tags Add
Add tags to the target record.
|
|
Response
|
|
Tags Retrieve
Fetch tags applied on the target record.
|
|
Response
|
|
Tags Delete
Drop tag(s) applied to the target record.
|
|
Response
|
|
Files Retrieve
This special API lets you pull the content of the linked image (Contacts, Products) that are not embedded as part of the record.
|
|
resource_id: You obtain this value through record retrieval (example: imageattachmentids field value of Contacts module record).
Response
|
|
Lookup
This API enables you to search records with a phone or email ID in different modules and fields.
|
|
Get Account Hierarchy
Accounts can be linked to parent Accounts and hence form a hierarchy. Information about this hierarchy can be retrieved through this API.
|
|
Response
|
|
Search for Phone or Email address
You can look up a phone number or email address in the CRM.
|
|
Response
|
|
Note: You can use a web service endpoint that supports session-based operation, which works better for repeated operations.
Add Picklist
You can use this API to add new Picklist values for a Picklist Field in a specific module.
|
|
Response
|
|
Edit Picklist
You can use this API to edit a Picklist value for a Picklist Field in a specific module.
|
|
Response
|
|
Delete Picklist
You can use this API to delete Picklist values for a Picklist Field in a specific module.
Note: Deleting Picklist values requires a replacement Picklist value. You cannot delete values without replacing them with an existing picklist value.
|
|
Response
|
|
Note:
- You cannot use the Add Picklist, Edit Picklist, or Delete Picklist APIs to update Picklist values in Global Picklists.
- You must be a CRM admin to use the Add Picklist, Edit Picklist, or Delete Picklist APIs. Non-admin users are restricted.
- You cannot use the Add Picklist, Edit Picklist, or Delete Picklist APIs for disabled modules.
Quick Reference
CRM Modules
List of default CRM modules exposed by the API. Alternatively, you can use the ListTypes API to get all the standard and custom modules available in your account.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| The FAQ module is used to manage the frequently asked questions by your customers. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Module IDs (Examples)
The following are sample IDs shown as references. You can get the values for provisional accounts with Rest API method - Describe API.
Standard module ID uses list types to get a more accurate value on your account.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Vtiger CRM Edition Limits API
The Vtiger CRM Edition Limits API allows users to check system restrictions on various functionalities. This API helps monitor limits such as email campaigns, document uploads, workflow executions, and storage, ensuring efficient CRM usage.
API Endpoint
The API request should be made to the following URL:
instanceurl/restapi/v1/vtiger/default/editionLimits
Replace instanceurl with the actual Vtiger CRM instance URL.
Request Parameters
- The serviceName specifies the CRM feature whose limit needs to be retrieved.
- The serviceName must be selected from the predefined list of allowed keywords.
- The authentication process follows the same method as existing REST API calls.
Service Name Keywords
The following are the allowed service names:
- INBOX_LIMIT
- GMAIL_TWO_WAY_SYNC
- IMPORT_FILE_LIMIT
- DOCUMENT_UPLOAD_FILE_LIMIT
- SCHEDULED_WORKFLOW
- EMAILCAMPAIGN_LIMIT
- MODULE_BUILDER_LIMIT
- BHOUR_RECORD_LIMIT
- SLA_RECORD_LIMIT
- WEBHOOKS_ACTIONS
- WEBHOOK_CALLS
- REPORTS_COLUMN_LIMIT
- CUSTOM_FIELD_LIMIT_BY_TYPE_PER_MODULE
- PICKLIST_VALUES_MAX_ALLOWED
- SCHEDULED_WORKFLOW_RECORD_SET_LIMIT
- MULTIPATH_WORKFLOW_LIMIT
- WORKFLOW_ACTIONS
- SCHEDULED_WORKFLOW_HOURLY_LIMIT
- SCHEDULED_WORKFLOW_DAILY_LIMIT
- STORAGE
- STORAGE_USER_QUOTA
- WORKFLOW_SEND_EMAIL_ATTACHMENTS_LIMIT
- MASSEMAIL_TRIAL_LIMIT
- MASSEMAIL_EDITION_LIMIT
- MENTION_UPLOAD_FILE_LIMIT
- EMAILS_TRIAL_LIMIT
- EMAILS_EDITION_LIMIT
- DASHBOARD_TAB_LIMIT
- ATTACHMENTS_UPLOAD_LIMIT
- SUMMARY_WIDGET_CUSTOM_LIMIT
- CUSTOM_FIELD_LIMIT
- WORKFLOW_LIMIT
- APPROVALS_PROCESS_LIMIT_PER_MODULE
- APPROVALS_RULES_LIMIT_PER_PROCESS
- APPROVALS_PROCESS_LIMIT
- GLOBAL_PICKLISTS_LIMIT
- LBL_PIVOT_REPORT
- LBL_CHARTS
- SCHEDULED_REPORT
- SESSION_LIMIT_PER_DEVICE
- LIGHT_AGENT_ROLE
- SINGLE_APP_ROLE
- LIGHT_AGENT_USER
- CCEMAIL_LIMIT
- SENSITIVE_FIELD_LIMIT
- SINGLE_APP_USER
- MINILIST_MAX_ALLOWED_COLUMNS
- WEBSERVICE_LIMIT
- EMAILSEQUENCE_USER_DAILY_EMAILS_LIMIT
- LBL_CUSTOM_REPORT
- PROFILES_LIMIT
- ROLES_LIMIT
- CUSTOM_CONSENT_FIELD_LIMIT
- PIVOT_DATA_LIMIT
- WEBSENSE_TRACKER_LIMIT
- HELPDESK_EMAILS_LIMIT
- APPROVALS_REQUEST_EMAIL_ATTACHMENTS_LIMIT
- FIELD_CUSTOM_VALIDATION_RULE_LIMIT
- SMSREPLY_RULES
- SMSREPLY_ACTIONS
- LINE_ITEMS_CUSTOM_FIELD_LIMIT
- MODULEDESIGNER_MODULE_TAPSCRIPTS_LIMIT
- MODULEDESIGNER_INSTANCE_TAPSCRIPTS_LIMIT
- MODULEDESIGNER_MODULE_TAPSTYLES_LIMIT
- MODULEDESIGNER_INSTANCE_TAPSTYLES_LIMIT
- MODULEDESIGNER_MODULE_PAGES_LIMIT
- MODULEDESIGNER_INSTANCE_PAGES_LIMIT
- APIDESIGNER_API_LIMIT
- LBL_SERVICE_LEVEL_AGREEMENT_MODULE_LIMIT
- METRIC_PICKLIST_VALUES_MAX_ALLOWED
- LANDING_PAGES_EDITION_LIMIT
- SOCIAL_FACEBOOK_LIMIT
- SOCIAL_INSTAGRAM_LIMIT
- SOCIAL_GOOGLE_LIMIT
- SOCIAL_TWITTER_LIMIT
- SOCIAL_SEARCHSTREAMS_LIMIT
- IMAGE_MAX_UPLOAD_SIZE
- PROCESS_DESIGNER_PROCESS_PER_MODULE
- PROCESS_DESIGNER_FLOWS_PER_PROCESS
- PROCESS_DESIGNER_ACTIONS_PER_FLOW
- RADIO_VALUES_MAX_ALLOWED
- FACEBOOKLEADS_RECORD_LIMIT
- CCEMAIL_TRIAL_LIMIT
- BCCEMAIL_TRIAL_LIMIT
- BCCEMAIL_LIMIT
- LIVE_CHAT_AGENTS_LIMIT
- INSIGHTSDESIGNER_INSIGHT_LIMIT
- INSIGHTSDESIGNER_INSIGHT_WIDGET_LIMIT
- PROCESS_DESIGNER_SCHEDULED_PROCESS
- PROCESS_DESIGNER_SCHEDULED_PROCESS_FLOWS
- SLA_NOTIFICATION_LIMIT
- EXPORT_LIMIT
- SCHEDULED_WORKFLOW_RECORDS_LIMIT
- LAYOUT_DESIGNER_RECORDS_LIMIT
- CSATSURVEYS_RECORDS_LIMIT
- MACROS_JOB_DAILY_RUN_LIMIT
- MACROS_SCRIPT_DAILY_RUN_LIMIT
Example API Request
To check the document upload file limit, send a request as follows:
Request URL
|
|
Request Parameters
|
|
Example API Response
|
|
This response indicates that the maximum document upload file size allowed is 50MB.
Limitations
- You cannot perform sync on user-defined modules and non-entity modules such as Currency, Groups, etc.
- You cannot run queries on non-entity modules such as Currency, Groups, etc.
- You cannot use the Add Picklist, Edit Picklist, or Delete Picklist APIs to update values in Global Picklists.
- You must be a CRM admin to use the Add Picklist, Edit Picklist, or Delete Picklist APIs. Non-admin users are restricted.
- You cannot use the Add Picklist, Edit Picklist, or Delete Picklist APIs for disabled modules.
Enhancement
- You can now enable APIs to create multiple records with a single REST API. This helps in creating multiple module records at the same time.
- Added sub-request to call request on previous response and append that response with the previous response object.