Users APIs

List Users

Purpose

To fetch the list of all available users.

Request URL

https://fsm.zoho.com/fsm/v1/users

Request Method

GET

Scope

scope=ZohoFSM.users.READ

Query Parameters

Parameter NameData TypeDescription
skillInfoBooleanWhen set to true, the API response will include the user's skill details. If omitted or set to false, skill details will not be included.

Sample Request

Copiedcurl --location --request GET 'https://fsm.zoho.com/fsm/v1/users' \
--header 'Authorization: Zoho-oauthtoken 1xxx.xxxxxxxxxx'

Sample Response

Copied{
    "users": [
        {
            "country": null,
            "Organization": "Zylker",
            "city": null,
            "language": "en_US",
            "locale": "en_US",
            "Isonline": false,
            "Modified_By": {
                "name": "Maggie Bell",
                "id": "20761000000298001"
            },
            "street": null,
            "alias": null,
            "id": "20761000000298001",
            "state": null,
            "fax": null,
            "country_locale": "US",
            "first_name": "Maggie",
            "email": "maggie.bell@noemail.com",
            "Reporting_To": null,
            "zip": null,
            "created_time": "2025-01-21T02:51:55-08:00",
            "Service_Resources": {
                "User": "20761000000298001",
                "id": "20761000000298308",
                "SE_PRESENCE": 1,
                "isActive": true,
                "Name": "Maggie Bell"
            },
            "website": null,
            "Territory": null,
            "Modified_Time": "2025-03-20T00:00:15-07:00",
            "time_format": "hh:mm a",
            "offset": -25200000,
            "profile": {
                "api_name": "Administrator",
                "name": "Administrator",
                "id": "20761000000108442"
            },
            "client_profile": "Administrator",
            "mobile": null,
            "sr_creation": true,
            "last_name": "Bell",
            "time_zone": "America/Los_Angeles",
            "created_by": {
                "name": "Maggie Bell",
                "id": "20761000000298001"
            },
            "zuid": "876610956",
            "confirm": true,
            "full_name": "Maggie Bell",
            "client_status": "Active",
            "phone": null,
            "dob": null,
            "Active_Territory": null,
            "employee_id": null,
            "date_format": "MMM dd, yyyy",
            "status": "active"
        },
        {
            "country": null,
            "Organization": "Zylker",
            "city": null,
            "language": "en_US",
            "locale": "en_US",
            "Isonline": false,
            "Modified_By": {
                "name": "Maggie Bell",
                "id": "20761000000298001"
            },
            "street": null,
            "alias": null,
            "id": "20761000000307025",
            "state": null,
            "fax": null,
            "country_locale": "US",
            "first_name": "Omar",
            "email": "omar.idan@noemail.com",
            "Reporting_To": null,
            "zip": null,
            "created_time": "2025-03-20T00:01:15-07:00",
            "Service_Resources": {
                "User": "20761000000307025",
                "id": "20761000000307035",
                "SE_PRESENCE": 1,
                "isActive": true,
                "Name": "Omar Zidan"
            },
            "website": null,
            "Territory": null,
            "Modified_Time": "2025-03-20T00:01:15-07:00",
            "time_format": "hh:mm a",
            "offset": -25200000,
            "profile": {
                "api_name": "Dispatcher",
                "name": "Dispatcher",
                "id": "20761000000108448"
            },
            "client_profile": "Dispatcher",
            "mobile": null,
            "sr_creation": true,
            "last_name": "Zidan",
            "time_zone": "America/Los_Angeles",
            "created_by": {
                "name": "Maggie Bell",
                "id": "20761000000298001"
            },
            "zuid": null,
            "confirm": false,
            "full_name": "Omar Zidan",
            "client_status": "Invited",
            "phone": null,
            "dob": null,
            "Active_Territory": null,
            "employee_id": null,
            "date_format": "MMM dd, yyyy",
            "status": "active"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 2,
        "page": 1,
        "more_records": false
    }
}