Vtiger CRM is online software that helps 300000+ businesses grow sales, improve marketing ROI, and deliver great customer service.
Vtiger Cloud offers 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/per user based on the Edition. For more details, click here.
Essentials
Endpoint:
The base URL or endpoint of API will be specific to your CRM Instance. Example: https://your_instance.odx.vtiger.com/restapi/v1/vtiger/default
Authentication:
Restapi expects your (username and access key) details. 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:
Restapi uses a composite key to represent record id, a combination of (module-type-id and module-record-id) separated by (x).