Returns a consolidated list of organization members. Includes both accepted and pending members. Optionally filter results by role ID or user status.

API

POST /api/v2/users/detail

OAuth Scope

ZohoAssist.userapi.READ

 

ParametersData TypeDescription
role_idsJSONArrayArray of role IDs to filter results by. 
When omitted, users across all roles are returned.
statusJSONArrayFilters results by member status. 
Accepted values: "accepted", "pending", "expired". 
When omitted or when all three values are provided, all statuses are returned.

Get All User

RequestResponse
Copiedcurl --location 'https://assist.zoho.com/api/v2/users/detail' \
--header 'Authorization: Zoho-oauthtoken 1000.84f8*****************************************' \
--data '{
    "role_ids": [742*************, 7426************],
    "status": ["accepted"]
}'

Copied{
  "representation": {
    "pending": [
      {
        "email": "invited_user@zylker.com",
        "role_id": "7426************",
        "non_editable_role": "",
        "urs_groups": [],
        "departments": ["7000**********"],
        "type": "pending",
        "invitation_id": "74260*********"
      }
    ],
    "accepted": [
      {
        "user_id": "117793916",
        "is_email_verified": true,
        "email": "malcom@zylker.com",
        "role_id": "7420************",
        "non_editable_role": "SUPER_ADMIN",
        "urs_groups": [],
        "departments": [
          "7000**********"
        ],
        "type": "accepted"
      }
    ],
    "expired": [
      {
        "email": "expired_invite@zylker.com",
        "role_id": "7426************",
        "non_editable_role": "",
        "urs_groups": [],
        "departments": [],
        "type": "expired",
        "invitation_id": "74260*********"
      }
    ],
    "inviteInProgress": false,
    "canDisplayZohoDirectory": true
  },
  "resource_type": "/api/v2/users/detail"
}

Sample payload

Copied{
  "role_ids": [742*************, 7426************],
  "status": ["accepted", "pending", "expired"]
}