Zoho User List

Purpose

To fetch the details of the Zoho users.

Request URL

{{api-domain}}/phonebridge/v3/users

Request Method

GET

Parameters

Parameter Name	Data Type	Description	Possible Values
page	Integer	The page from which the records must be fetched.	Positive integer values. The default value is 1.
perPage	Integer	The number of records you want to fetch per page.	Positive integer values from 1 to 1000. The maximum value is 1000.

Possible Errors

HTTP Status	Error Code	Message	Reason
400	SC_BAD_REQUEST	PROVIDER_NOT_REGISTERED	The PhoneBridge registration information is not available for the Provider name obtained from the OAuth Token object.
403	SC_FORBIDDEN	NO_PERMISSION	Requested user does not have enough privilege in Zoho PhoneBridge to enable the PhoneBridge integration.
403	SC_FORBIDDEN	DIFFERENT_PROVIDER_ALREADY_ENABLED	A different Provider integration has been enabled for the account already.
500	SC_INTERNAL_SERVER_ERROR	INTERNAL_ERROR	An exception occurred while processing the request.

Sample Request

Copiedcurl "https://www.zohoapis.com/phonebridge/v3/users?page=1&perPage=200"
-X GET 
-H "Authorization: Zoho-oauthtoken 1000.xxxxxxxxxxxxx.ebd1"

Sample Response

Copied{
  "navigation": {
    "firstPage": {
      "uri": "https://www.zohoapis.com/phonebridge/v3/users?page=(page-1)&perPage=(perPage-1)"
    },
    "lastPage": {
      "uri": "https://www.zohoapis.com/phonebridge/v3/users?page=(page+1)&perPage=(perPage+1)"
    }
  },
  "users": [
    {
      "zohouser": zohouservalue,
      "email": email id of the user,
      "username": user full name
    }
     .
     .
     .
  ],
  "paging": {
    "perPage": number of records displayed,
    "page": page number
  }
}