Get Clients List | API

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.

Sample Request

Copiedhttps://people.zoho.com/people/api/timetracker/getclients?sIndex=0&limit=1

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Sample Response

Json XML

Copied{
    "response": {
        "result": [
            {
                "lastName": "Meyrick",
                "country": "UNITED STATES",
                "pincode": "32104",
                "streetAddr": "50, Oakland Avenue",
                "clientId": "469505000000133417",
                "clientName": "Adamo Meyrick",
                "city": "#206 A city",
                "description": "Food Door Delivering Company",
                "emailId": "ameyrickd@wix.com",
                "industry": "Voolia",
                "mobileNo": "7708753134",
                "phoneNo": "656-630-9381",
                "firstName": "Adamo",
                "faxNo": "+1-212-9876543",
                "compsize": 230,
                "state": "Florida",
                "currencyCode": "USD"
            }
        ],
        "message": "Data fetched successfully",
        "uri": "/api/timetracker/getclients",
        "isNextAvailable": true,
        "status": 0
    }
}

Copied<?xml version="1.0" encoding="UTF-8"?>
<response uri="/api/timetracker/getclients">
    <status>0</status>
    <message>Data fetched successfully</message>
    <isNextAvailable>true</isNextAvailable>
    <result>
        <client>
            <lastName>Meyrick</lastName>
            <country>UNITED STATES</country>
            <pincode>32104</pincode>
            <streetAddr>50, Oakland Avenue</streetAddr>
            <clientId>469505000000133417</clientId>
            <clientName>Adamo Meyrick</clientName>
            <city>#206 A city</city>
            <description>Food Door Delivering Company</description>
            <emailId>ameyrickd@wix.com</emailId>
            <industry>Voolia</industry>
            <mobileNo>7708753134</mobileNo>
            <phoneNo>656-630-9381</phoneNo>
            <firstName>Adamo</firstName>
            <faxNo>+1-212-9876543</faxNo>
            <compsize>230</compsize>
            <state>Florida</state>
            <currencyCode>USD</currencyCode>
        </client>
    </result>
</response>