Find Record_ID for REST API in vTiger CRM: Quick Guide

To find the record_Id in vTiger CRM for REST API, which typically follows the format module-type-id x module-record-id, follow these steps:

1. Access the vTiger CRM

• Log in to your vTiger CRM as an administrator or a user with API access privileges.

2. Determine the Module Type ID

• Each module in vTiger (e.g., Contacts, Leads, Accounts) has a unique module-type-id. To find this ID:
  • Navigate to the Module Manager in the settings.
  • Find the module you want to work with (e.g., Leads, Contacts) and check its details to identify its module-type-id.
  • You can also refer to vTiger’s documentation or inspect the module’s URL when viewing a record (the module ID is part of the URL).

3. Find the Record ID

• The module-record-id is a unique identifier for a specific record within a module. To find it:
  • Navigate to the record you need (e.g., a specific contact or lead).
  • The record ID is often visible in the URL of the page, after the module name. For example, in a URL like https://your-vtiger-instance/index.php?module=Contacts&view=Detail&record=12345, 12345 is the record ID.
  • Alternatively, you can query the API for all records within a module and extract the specific record’s ID from the response.

4. Combine the Module Type ID and Record ID

• Once you have both the module type ID and the record ID, combine them in the format:
  module-type-id x module-record-id
  For example, if the module type ID is 4 (for Leads) and the record ID is 12345, the combined record_Id would be:

   4x12345

5. Use the Record ID in the REST API

• Now that you have the record_Id, you can use it in your REST API calls to interact with the specific record in vTiger CRM. Ensure that you authenticate properly and use the correct API endpoint for retrieving, updating, or deleting records.

This method helps to precisely identify any record across different modules for API operations in vTiger CRM.

Conclusion

To find out the record_Id in the case of vTiger CRM specifically for REST API, which simply follows the proper format module-type-id x module-record-id, follow all above-mentioned steps by having the best Vtiger hosting solutions.