GET - Get a single user by ID
 

Purpose

Use this API to fetch single user details.
 

Authorization

HeaderKeyDescription
Authorization*Zoho-oauthtoken<space><ACCESS_TOKEN>
Accept*Set to application/json.

Request URL

Method: GET

https://voice.zoho.com/rest/json/zv/api/users/[userid]

Scope: ZohoVoice.agents.READ

Parameters:

Param Name

Data Type

Description

id*

Long

Represents the unique ID of the user.

Sample Request

Copiedcurl "https://voice.zoho.com/rest/json/zv/users/96000000016003" \
-X GET \
-H "Authorization: Zoho-oauthtoken *****"

Sample Response - Success

Copied{
  "code": "200",
  "users": {
    "extension": 10023,
    "agentId": "4061000000146033",
    "dailyReportEnabled": true,
    "timezone": "GMT",
    "mobileNumber": "",
    "onlineStatus": "Available",
    "canEdit": true,
    "departmentId": "4061000000054011",
    "userid": "4061000000002005",
    "canEditOnlineStatus": true,
    "isCurrentUser": true,
    "zvtRole": 0,
    "countryCode": 93,
    "company": "ZohoVoice",
    "lang": "en",
    "associatedAgents": [],
    "retentionPeriod": -1,
    "departmentName": "AlarmsOne",
    "lastActiveTime": 1736426969071,
    "addOn": {
      "POWER_DIALER": true
    },
    "commServerStatus": "Completed",
    "emailid": "john@zylker.com",
    "canChangeModerator": false,
    "zuid": 63356552,
    "zvtRoleName": "SUPERADMIN",
    "name": "John",
    "status": 1,
    "reportTime": "16:00"
  },
  "status": "SUCCESS"
}

Sample Response - Error

Copied{
  "code": "ZVT011",
  "message": "Given URL is wrong.",
  "status": "ERROR"
}