Get Clients API
This API is used to get the list of clients
Request URL:
https://people.zoho.com/people/api/timetracker/getclients?sIndex=<sIndex>&limit=<limit>
Header:
Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
Scope:
ZOHOPEOPLE.timetracker.ALL
OR
ZOHOPEOPLE.timetracker.READ
Possible Operation Types:
ALL - Complete access to data
DELETE - Only to delete data
Request parameter:
| Parameter | Values Allowed | Default Value | Description |
| sIndex | <sIndex> | 0 | Specify from which record the response should be fetched |
| limit | <limit> | 200 | Specify the number of records to be fetched. Maximum value is 200 |
Error Codes and Messages :
| Error Code | Error Message |
| 9000 | Permission denied |
Note:
- This API will be permitted only for the Admin.
Success Response Format
{
"response": {
"result": [
{
"clientId": <Client Id>,
"clientName": <Client name>,
"currencyCode": <Currency code>
"billingMethod": <hourly job rate | hourly user rate | hourly user rate - jobs | hourly user rate - projects>,
"emailId": <Email Id>,
"firstName": <First name>,
"lastName": <Last name>,
"phoneNo": <Phone number>,
"mobileNo": <Mobile number>,
"faxNo": <Fax number>,
"streetAddr": <Street address>,
"city": <City>,
"state": <State>,
"pincode": <Pin code>,
"country": <Country>,
"industry": <Industry name>,
"compsize": <Company size>,
"description": <Description>
},....
],
"message": "Data fetched successfully",
"uri": "/api/timetracker/getclients",
"isNextAvailable": true, (NOTE: this key will not be available if there is no more data)
"status": 0
}
}
Error Response Format
{
"response": {
"message": Error in fetching data,
"uri": "/api/timetracker/getclients",
"errors": [
{
"code": <Error Code>,
"message": <Error Message>
}
],
"status": 1
}
}
Threshold Limit: 20 requests | Lock period: 5 minutes
Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.