Let us create a REST API that can access
Posted: Thu May 29, 2025 6:37 am
The API Designer is a tool or application developer can use to build custom web service APIs. You can define custom service endpoints and query parameters. These APIs can be used to interact with CRM data, integrate with external applications, and also expose this data to the VTAP Javascript API for use in custom pages or widgets in the Vtiger UI.
You can create APIs using Vtiger Application Design Language ( VADL ), which is loosely based on XML syntax. VADL allows administrators or developers without advanced programming skills to easily define APIs, but with a basic understanding of programming, you can quickly create effective APIs.
REST APIs follow the standard REST API protocol and you can define their endpoints as follows:
For the REST API, the following HTTP request methods are supported:
Vtiger CRM users can build REST APIs that will connect the CRM with other europe cell phone number list third-party applications or build new applications that will extend the CRM's functionality. Here is an example:
Let us create a REST API that can access data from a specific module using VTAP.
Here is an example of an API that retrieves data from a CRM module called Organizations to display the top five organizations with the highest annual revenue with the API name top_organizations . You could go with a different name to keep it unique.
Before we begin, let us understand the XML and VDAL elements that will be used to define the actions of the above API example.
The following table describes the XML and VDAL elements that will be used to define a custom REST API to access and display CRM data:
You can create APIs using Vtiger Application Design Language ( VADL ), which is loosely based on XML syntax. VADL allows administrators or developers without advanced programming skills to easily define APIs, but with a basic understanding of programming, you can quickly create effective APIs.
REST APIs follow the standard REST API protocol and you can define their endpoints as follows:
For the REST API, the following HTTP request methods are supported:
Vtiger CRM users can build REST APIs that will connect the CRM with other europe cell phone number list third-party applications or build new applications that will extend the CRM's functionality. Here is an example:
Let us create a REST API that can access data from a specific module using VTAP.
Here is an example of an API that retrieves data from a CRM module called Organizations to display the top five organizations with the highest annual revenue with the API name top_organizations . You could go with a different name to keep it unique.
Before we begin, let us understand the XML and VDAL elements that will be used to define the actions of the above API example.
The following table describes the XML and VDAL elements that will be used to define a custom REST API to access and display CRM data: