![User Accounts]({"bg": "//theme.zdassets.com/theme_assets/9373496/e106cc8a79a6a41c781c71d999cffaa33b481de7.jpg"})
![User Accounts]({"bg": "//theme.zdassets.com/theme_assets/9373496/d38d9cc5a4fcb160800cb7a8f0e0cb60aaa36d2e.jpg"})
User Accounts
User accounts includes the details of all accounts within the LMS.
Get all user accounts:
| Description |
Returns all user accounts within the tenancy. |
| Request Method | GET |
| Request URL | {{base_url}}/local/acorn_tenancymanagement/index.php/api/1.1/tenancies/{{tenancy_id}}/useraccounts |
| Authorisation Header | Bearer {api_key} |
Query String Parameters:
| Parameter | Data Type | Details |
| requestid | integer | optional, if included the endpoint will return the status and results of the request with the specified requestid. If not included a new request will be submitted and its requestid will be returned |
| showSuspended | boolean | optional, if true suspended user accounts will be included |
| userFields | boolean |
optional, if true user account records will include all custom user fields |
Example Response without requestId included:
{
"requestid": 161,
"status": "Processing"
}
Example Response with requestId included:
If request is still processing:
{
"requestid": 161,
"status": "Processing"
}
If request is complete:
{
"requestid": 161,
"status": "Complete",
"data": [
{
"userid": 33,
"username": "hope.renner@example.com",
"email": "hope.renner@example.com",
"firstname": "Hope",
"lastname": "Renner",
"lastaccess": "Never",
"lastupdated": "2021-05-03T00:49:23+00:00",
"suspended": "No",
"tenancyname": "Internal Staff"
},
{
"userid": 29,
"username": "toni54@example.com ",
"email": "toni54@example.com",
"firstname": "Toni",
"lastname": "Wardwina",
"lastaccess": "2020-05-15T06:45:55+00:00",
"lastupdated": "2022-04-03T09:42:29+00:00",
"suspended": "No",
"tenancyname": "Internal Staff"
}
]
}
0
0
Was this article helpful?
0 out of 0 found this helpful
Add comment
Please sign in to leave a comment.