Get Active Users
Purpose
To get active users in the organization and their details.
Endpoints
Request Details
Request URL
https://contracts.zoho.com/api/v1/activeusers
Authorization
Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6
Scope
contracts.meta.READ, contracts.contracts.ALL
Possible Operation Types
ALL - Full access to user details
READ - Get user details
Sample Request
Copiedcurl "https://contracts.zoho.com/api/v1/activeusers"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"Response JSON Keys
- displayNamestring
Represents the name of the user.
- emailIdstring
Represents the email ID of the user.
- idstring
Represents the unique ID of the user.
- zuidlong
Represents the Zoho User ID of the user.
Possible Errors
INVALID_URL_PATTERNHTTP 404
Request URL is incorrect
Resolution: Specify a valid request URL. Refer to the Request URL section above.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have contracts.meta.READ scope. Create a new client with valid scope. Refer to the Scope section above.
NO_PERMISSIONHTTP 403
Permission denied to read
Resolution: The user does not have permission to read records. Contact your organization administrator.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in the server.
INVALID_REQUEST_METHODHTTP 400
The HTTP request method is not a valid one.
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to the Endpoints section above.
AUTHORIZATION_FAILEDHTTP 400
The user does not have sufficient privilege to read module details.
Resolution: The user does not have permission to retrieve module details. Contact your organization administrator.
Sample Response
Copied{
"activeusers":[
{
"displayName": "Smith Jones",
"emailId": "smith.jones@zylker.com",
"id": "596000000183025",
"zuid": 73583287
},
{
"displayName": "Anna Hilla",
"emailId": "anna.hilla@zylker.com",
"id": "4420000000166067",
"zuid": 77190576
},
{
"displayName": "Steve Reeder",
"emailId": "steve.reeder@zylker.com",
"id": "4420000000165503",
"zuid": 77166011
}
]
}