This API call returns a list of users, including groups.
See Avatars for more useful information on Avatar usage.
- API URL
- https://youraccount.beetil.com/external_api/v1/users.format
- HTTP Method
- GET
URL parameters
| Parameter | Format | Default | Mandatory |
|---|---|---|---|
| service_idService id to return users for. | integer | No |
Example JSON Response
{
"result": {
"users": [
{
"user_link": "/external_api/v1/users/7",
"avatar": null,
"id": 7,
"full_name": "admin God",
"last_name": "God",
"first_name": "admin"
},
{
"user_link": "/external_api/v1/users/117",
"avatar": null,
"id": 117,
"full_name": "admin God",
"last_name": "God",
"first_name": "admin"
},
{
"avatar": null,
"id": 1039848703,
"group_link": "/external_api/v1/users/1039848703",
"full_name": "Beetil Group",
"last_name": null,
"first_name": "Beetil Group"
},
{
"user_link": "/external_api/v1/users/2",
"avatar": null,
"id": 2,
"full_name": "dan Lee",
"last_name": "Lee",
"first_name": "dan"
},
{
"user_link": "/external_api/v1/users/1039848704",
"avatar": null,
"id": 1039848704,
"full_name": "Empty User",
"last_name": "User",
"first_name": "Empty"
},
{
"user_link": "/external_api/v1/users/10",
"avatar": null,
"id": 10,
"full_name": "luke Grimstrup",
"last_name": "Grimstrup",
"first_name": "luke"
},
{
"user_link": "/external_api/v1/users/167",
"avatar": null,
"id": 167,
"full_name": "Password Expired",
"last_name": "Expired",
"first_name": "Password"
},
{
"user_link": "/external_api/v1/users/11",
"avatar": null,
"id": 11,
"full_name": "quentin Jones",
"last_name": "Jones",
"first_name": "quentin"
},
{
"avatar": null,
"id": 168,
"group_link": "/external_api/v1/users/168",
"full_name": "Support Group",
"last_name": "groups dont have last names",
"first_name": "Support Group"
}
]
},
"version": "1.0",
"status": "Success"
}Last updated 31 January 2011