Retrieve a paginated list of all users in the organization

Retrieves a paginated list of all users configured in the organization, including their login ID, role, email, phone number, creation time, and account status. Supports page-based pagination.

Endpoints

get /emsapi/users/info

Copy full URL

Request URL

https://{serverurl}/emsapi/users/info

Scope

DesktopCentralCloud.Admin.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

pageintegerOptional

Page number for pagination. Starts from 1. Returns the first page if not specified.

pageLimitintegerOptional

Maximum number of user records to return per page. Uses system default of 25 if not specified.The maximum allowed value is 1000.

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomains/emsapi/users/info \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomains/emsapi/users/info"))
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

headers = { 'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52" }

conn.request("GET", "/emsapi/users/info", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://appDomains/emsapi/users/info"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/emsapi/users/info' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

metadataJSON Object

Pagination metadata describing the current page and limit applied.

Show Sub-Attributes

limitinteger

Maximum number of user records returned per page as specified in the request.

pageinteger

Current page number of the paginated result as specified in the request.

totalRecordsstring

Total number of user records available in the organization across all pages.

messageResponseJSON Array

Paginated list of user detail objects returned for the current page.

Show Sub-Attributes

JSON Object

Show Sub-Attributes

creation_timestring

Timestamp when the user account was created (e.g., 'Nov 3, 2025 12:26 PM').

login_idstring

Unique login identifier for the user.

modified_timestring

Timestamp when the user account was last modified.

um_role_idstring

Unique identifier of the role assigned to the user.

phonenumberstring

Phone number of the user.

um_role_namestring

Name of the role assigned to the user (e.g., 'Administrator', 'Technician').

emailstring

Email address of the user.

usernamestring

Username used for login.

statusstring

Account status of the user ('1' = active).

totalPagesinteger

Total number of pages available based on totalRecords and the current page limit.

LinksJSON Object

Navigation links for moving to the next or previous page of results.

Show Sub-Attributes

nextstring

URL path to the next page of results. null when the current page is the last page.

prevstring

URL path to the previous page of results. null when the current page is the first page.

statusstring

Response status. 'success' confirms the user list was fetched successfully.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Page 1 of users with the default limit of 25. Links.next and Links.prev are null when only one page exists.

Copied!

  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "3",
    "messageResponse": [
      {
        "creation_time": "Nov 3, 2025 12:26 PM",
        "login_id": "9502000000134133",
        "modified_time": "Nov 3, 2025 12:26 PM",
        "um_role_id": "9502000000014452",
        "phonenumber": "12312312131",
        "um_role_name": "Security Auditor",
        "email": "alex.morgan@example.com",
        "username": "alex.morgan",
        "status": "1"
      },
      {
        "creation_time": "Nov 3, 2025 12:26 PM",
        "login_id": "9502000000122681",
        "modified_time": "Nov 3, 2025 12:26 PM",
        "um_role_id": "9502000000014452",
        "phonenumber": "1231231231",
        "um_role_name": "Endpoint Administrator",
        "email": "jamie.chen@example.com",
        "username": "jamie.chen",
        "status": "1"
      },
      {
        "creation_time": "Nov 3, 2025 12:26 PM",
        "login_id": "9502000000120677",
        "modified_time": "Nov 3, 2025 12:26 PM",
        "um_role_id": "9502000000014452",
        "phonenumber": "",
        "um_role_name": "Service Desk Operator",
        "email": "service.desk@example.com",
        "username": "service.desk",
        "status": "1"
      }
    ],
    "totalPages": 1,
    "Links": {
      "next": null,
      "prev": null
    },
    "status": "success"
  }

▼ Show full

Page 2 result when multiple pages exist. Links.prev points to page 1; Links.next is null on the last page.

Copied!

  {
    "metadata": {
      "limit": 25,
      "page": 2
    },
    "totalRecords": "30",
    "messageResponse": [
      {
        "creation_time": "Nov 5, 2025 09:10 AM",
        "login_id": "9502000000145001",
        "modified_time": "Nov 5, 2025 09:10 AM",
        "um_role_id": "9502000000014453",
        "phonenumber": "",
        "um_role_name": "Endpoint Technician",
        "email": "priya.shah@example.com",
        "username": "priya.shah",
        "status": "1"
      }
    ],
    "totalPages": 2,
    "Links": {
      "next": null,
      "prev": "/emsapi/users/info?page=1&pageLimit=25"
    },
    "status": "success"
  }

▼ Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.