Get Record IDs By Reference IDs API
To obtain the IDs of records for entities like Client, Project, Job, and time logs by using the IDs of records from other services. It is possible to retrieve the IDs of records that have been synced via Integrations.
Important Note
Record IDs can only be fetched for the following integrations:
Zoho People - Zoho Books/Invoice Integration
Zoho People - Zoho Projects Integration
Zoho People - Zoho CRM Integration
Sample Request
Sample Response
{
"response": {
"result": {
<ReferenceId_1> : <RecordId_1>,
<ReferenceId_2> : <RecordId_2>,
...
},
"message": "Data fetched successfully",
"uri": "/api/timetracker/getRecordIdsByReferenceIds",
"status": 0
}
}
Scope
ZOHOPEOPLE.timetracker.ALL
(or)
ZOHOPEOPLE.timetracker.READ
Possible Operation Types
ALL - Full access to data
READ - Only access to read data
Request Parameters
PARAMETERS | VALUES ALLOWED | DEFAULT VALUE | PARAMETER DESCRIPTION | MANDATORY |
---|---|---|---|---|
service | Zoho Books | Zoho Invoice | Zoho CRM | Zoho Projects | Specify the service that the provided referenceIds belong to. | Yes | |
entity | client | project | job | timelog | Specify the entity that the provided referenceIds belong to. | Yes | |
referenceId | <Reference Ids> | ReferenceIds - Ids of records in other services is referred as reference Ids. Specify the reference IDs of the entities for which you want to get the record IDs. Maximum number of IDs allowed is 200. | Yes |
Common Error Codes and Descriptions
ERROR CODE | ERROR DESCRIPTION |
---|---|
9000 | Permission Denied |
7019 | Missing parameter(s) in the request |
7205 | Input format does not match |
7214 | Maximum occurrences exceeded for referenceId. |
Threshold Limit: 50 requests | Lock period: 5 minutes
Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.