-
Print
-
DarkLight
GET/teams
Gets all the users
Header
Parameter | Type | Description |
---|---|---|
api_token | string | REST API key you can get it from Settings > Advanced > API tokens. |
Query Parameters
You can filter the results using the following parameters
Parameter | Type | Description |
---|---|---|
email_id | string | Specify an email of the user to fetch |
role_id | enumerated | 1 - Administrator, 2 - Editor, 3 - DraftWriter, 4 - Reader, 7 - Owner |
IsSsoUser | boolean | Specify if user is Single Sign-On user or not |
Sample Response
{
"data": [
{
"id": "5ae331f74e60146b233558c6",
"first_name": "Danny",
"last_name": "Brown",
"email_id": "danny.brown@document360.io",
"profile_logo_url": "https://s.gravatar.com/avatar/1b7c898ca4afb6c3ca5b7ccf89adc5a9.png",
"user_role": 7,
"last_login_at": "2019-02-20T16:38:40.102Z",
"unique_user_name": "daniel",
"sso_user_type": 1,
"is_sso_user" : true
}
],
"extension_data": null,
"context": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}
Response Data
Parameter | Type | Description |
---|---|---|
id | string | ID of the user |
first_name | string | First name of the user |
last_name | string | Last name of the user |
email_id | string | Email address of the user |
profile_logo_url | string | Profile image URL of the user |
user_role | enumerated | 1 - Administrator, 2 - Editor, 3 - DraftWriter, 4 - Reader, 7 - Owner |
last_login_at | datetime | Last login date of the user |
unique_user_name | string | Unique username of the user |
sso_user_type | enumerated | 0 - NormalUser, 1 - SSOUser, 2 - SSOUserInvited |
is_sso_user | boolean | Specfies if the user is a Signle Sign-On on user or not |
Was this article helpful?