Getting the list of users through API: get_users
Sample get_users request
https://your—domain.com/api/admin/v2/?action=get_users&hash=HASH
Returns account users data
This request does not require page parameter Returned data:
- id — unique user identifier
- first_name — user first name
- last_name — user last name
- name — user first and last name
- title — user position
- avatar — link to the user avatar image
- group — team name
- department — department name
- role — user role: owner, account admin, team admin, department admin, user, guest, reader
- email — user email
- phone — phone number (if specified)
- phone2 — office phone number (if specified)
- phone3 — mobile phone number (if specified)
- phone4 — home phone number (if specified)
- address — address (if specified)
- address2 — additional address (if specified)
Sample JSON response
If the request succeeds, the response will contain ok status and the following data:
{ "status": "ok", "data": [ { "id": "USER_ID", "first_name": "USER_FIRST_NAME_1", "last_name": "USER_LAST_NAME_1", "name": "USER_NAME", "title": "USER_POSITION", "avatar": "URL", "group": "USER_GROUP", "department": "USER_DEPARTMENT", "role": "USER_ROLE", "email": "USER_EMAIL", "phone": "USER_PHONE", "phone2": "USER_PHONE_2", "phone3": "USER_PHONE_3", "address": "USER_ADDRESS", "address2": "USER_ADDRESS_2" }, { "id": "USER_ID",
"first_name": "USER_FIRST_NAME_2",
"last_name": "USER_LAST_NAME_2",
... ... ... } ]}
Was this article helpful?
Yes, thank you!
No