Access CRM data offline via Vtiger 360 Accessing your Vtiger CRM data via OData feed Calendar View Capturing Emotional Journeys Closed States Customer Touchpoints Customizer Desktop Notification overview Exporting Data from Vtiger CRM Vtiger Feature Limits Glossary How do I scan a Business Card in Vtiger 360 mobile App IP Based Restriction Introduction to Kanban View Make the leap from Spreadsheets Merging Duplicates in Summary View Migration Timeframe and Process One View: Introduction Overview of Permission Usecases Performing Global Search Managing your Vtiger CRM Subscriptions & Billing Vtiger 360 for Field Sales Vtiger 360 Mobile App Contact Roles What are Record-Level Analytics What are Sticky Notes Whitelisting Vtiger to Configure Gmail Inbox What is Quick Create Using Grid Edit in Vtiger CRM Embedding a Video URL Built-in Phone Dialer in the CRM with Plivo and Twilio Summary View QR Code in Vtiger CRM Internal Chat Details View Vtiger SAML application in Microsoft Entra ID Understanding Email Bounces and Error Codes Course Completion Certificates Customizing a Course Category Applicable Taxes for Vtiger Billing

Introduction

Vtiger Cloud offers a REST-friendly API for integration with 3rd-party-applications. API accepts form-encoded request bodies with basic authentication as a header for security.

Limits per Edition

You can trigger a certain number of API calls per day/user based on the Edition. For more details, click here.

Essentials

Endpoint

• The base URL or endpoint of the API will be specific to your CRM  Instance.
• Example: https://your_instance.odx.vtiger.com/restapi/v1/vtiger/default.

Authentication

• REST API expects your details (username and access key). Authentication to the API is performed via HTTP Basic Auth.
• Accesskey information is a random token generated for each user and made available under My Preferences on the Web UI.

Response
HTTP response code 200 indicates the successful execution of the API. The response body will be in JSON format.
 

{ success: true, result: json_result  }

Error

• HTTP response code 400 indicates execution failure of the API. An error message is also stated along the header line.
• Other HTTP response codes, like 500, etc., should be considered a failure to serve the request.

Record Id: REST API uses a composite key to represent the record id, a combination of (module-type-id and module-record-id) separated by (x).

Postman collection 

You can use all the below APIs using the Postman collection. Use this link to access them.

APIs

Me: Authentication can be confirmed using this API before using any other operation. Response to this API can come in handy when user-reference-id is required.

 GET endpoint/me

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 operations further.

GET endpoint/describe?elementType=moduleName

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).

POST endpoint/create?elementType=moduleName&element=convert_into_json_string ({field1: value1, field2=value2})

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.

GET endpoint/retrieve?id=record_id

Response

 Decrypt: Use this API when you want to extract the value of a sensitive field of a record.
 

GET endpoint/decrypt?id=record_id&fieldname=field_name

Response

Update

• When you intend to update specific fields of existing records, you can use this or Revise API.
• Note: This API expects all the mandatory fields to be re-stated as part of the element parameter.
   

 POST endpoint/update?element=convert_into_json_string({id:record_id, field1:revalue1, field2:value2})

Response

Revise: This is similar to Update API but relaxes the constraint of re-stating the mandatory fields but expects target fields that need to be updated.

POST endpoint/revise?element=convert_into_json_string({id:record_id, field2:revalue2})

Response

 Delete: Delete existing records through this API.

POST endpoint/deleteid=record_id

Response

Query: Retrieve one or more records matching filtering field conditions.
 

GET endpoint/query?query=query_string
 

query_string:
 

select * | field_list | count(*) from module where conditions order by field_list limit m, n;

Here,

• field_list: should be a comma-separated list of field name.
• conditions can have expression having
  • operators: <, >, <=, >=, =, !=
  • clauses: in ( ), like ‘sql_regex’
• limit m, n: m representing offset, n representing count.

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.

GET endpoint/sync?modifiedTime=timestamp&elementType=moduleName&syncType=sync_type

• modified time: Last known modified time from where you expect state changes of records should be in UNIX timestamp. For example 1561718898
• syncType:
  • user: fetch records restricted to the assigned owner of the record.
  • userandgroup: fetch records restricted to the assigned owner of own’s group.
  • application: fetch records without restriction on the assigned owner.
• elementType: Target module name.

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.

GET endpoint/relatedtypes?elementType=moduleName

Response

Retrieve Related: When you need related records of a target, use this API to retrieve a record.

GET endpoint/retrieve_related?id=record_id&relatedLabel=target_relationship_label&relatedType=target_moduleName

Response

Query Related: Fetch related records matching search criteria using this API.
 

GET endpoint/query_related?query=query_string&id=record_id&relatedLabel=target_moduleName

Response

Add Related: Establish a relationship between the two records.
 

POST endpoint/add_related?sourceRecordId=record_id&relatedRecordId=target_record_id&relationIdLabel=target_relation_label

Response

Delete Related: When you are looking to break the existing relationship between two records, you can use this API.

POST endpoint/delete_related?sourceRecordId=record_id&relatedRecordId=target_record_id

Response

Reopen: Reopen closed record if permitted.

POST endpoint/reopen?id=record_id

Response

PicklistDependency: 

• You can get dependency between picklist fields.
• For example, you want to know all the details of the pipelines and stages dependency in your Deals module so you can configure your CRM to map them.

 GET endpoint/picklist_dependency?module=moduleName&&sourcefield=sourceFieldName&targetfield=targetFieldName

Example - GET endpoint/picklist_dependency?module=Potentials&sourcefield=pipeline&targetfield=sales_stage' \

Parameters:
- module: name of the module
- sourceField: field name where the dependency should be triggered
- targetField: field which changes according to sourceField values

Response

Tags Add: Add tags to the target record.

POST endpoint/tags_add?id=record_id&tags=convert_into_json_string(["tag1", "tag2"])

Response

Tags Retrieve: Fetch tags applied on the target record.

GET endpoint/tags_retrieve?id=record_id

Response

Tags Delete: Drop tag(s) applied on the target record. 
 

POST endpoint/tag_delete?id=record_id&tags=convert_into_json_string(["tag"])&delete_all=boolean

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.
 

 GET endpoint/files_retrieve?id=resource_id

resource_id: You obtain this value through record retrieve (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.

 GET endpoint/get_account_hierarchy?id=record_id

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 operation.

Quick Reference

 CRM Modules

List of default CRM modules exposed by the API. Alternatively, you can use “listtypes” API to get all the standard and custom modules available in your account.

Name	Description
Calendar	The Calendar module is used to manage To Dos, Events, and Meetings.
Leads	The Leads module is used to track sales leads.
Accounts	The Accounts module is used to manage individuals or organizations involved in your business.
Contacts	The Contacts module is used to manage individuals associated with an Account.
Potentials	The Potential module is used to manage sales opportunities.
Products	The Products module is used to manage the product that your organization sells.
Documents	The Documents module is used to manage the uploaded documents and notes.
Emails	The Emails module is an email client used to manage your emails.
HelpDesk	The HelpDesk module is used to track customer issues such as feedback, problems, etc.
Faq	The FAQ module is used to manage the frequently asked question by your customer.
Vendors	The Vendors module is used for managing manufacturers.
PriceBooks	The PriceBook module is used for managing the pricing of products.
Quotes	The Quotes module is used for managing the Quotes for products.
PurchaseOrder	The Purchase Order module is used for managing the Purchase Orders.
SalesOrder	The SalesOrder module is used for managing the SalesOrders.
Invoice	The Invoice module is used for creating invoice reports.
Campaigns	The Campaigns module is used for managing Marketing Campaigns.
Events	The Events module is used for managing activities such as Calls and Meetings.
Users	The Users module is used for managing the CRM users.
Groups	Users groups on the vtiger CRM.
Currency	The Currency module lets the administrator define different currencies and set the expected conversion rate with respect to the base currency. These currencies can be used in Inventory modules to support multi-currency.
DocumentFolders	The DocumentFolders module is used to Groups Documents.

Module ID: 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 “listtypes” to get a more accurate value on your account.
 

Module Name	ID number
Accounts	3
Assets	27
Calendar	1
Campaigns	17
Cases	39
CampanyDetails	26
Contacts	4
Currency	21
DocumentFolders	22
Documents	7
EmailCampaigns	37
Emails	8
Events	18
Faq	10
Groups	20
HelpDesk	9
Invoice	16
Leads	2
LineItem	33
ModComments	28
Olark	40
PBXManager	24
Potentials	5
PriceBooks	12
PrintTemplates	41
Products	6
ProductTaxes	35
Project	31
ProjectMilestone	29
ProjectTask	30
PurchaseOrder	14
Quotes	13
SalesOrder	15
ServiceContracts	23
Services	25
SLA	38
Tax	34
Users	19
Vendors	11

 

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

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:

instanceurl/restapi/v1/vtiger/default/editionLimits

Request Parameters:

{

    "serviceName": "DOCUMENT_UPLOAD_FILE_LIMIT"

}

Example API Response:

{

    "success": true,

    "result": {

        "serviceName": "DOCUMENT_UPLOAD_FILE_LIMIT",

        "limit": "50MB"

    }

}

This response indicates that the maximum document upload file size allowed is 50MB.

 

Limitation

• Sync does not work on the user’s module and non-entity modules like Currency, Groups, etc.
• The query does not work on non-entity modules like Currency, Groups, etc.

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.​​​​​​

API Designer in Vtiger CRM