GET api/v1/appusers
List app user
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Filter |
Filter records |
ListAppUserV1Filter |
None. |
| Select |
Select columns |
Collection of ListAppUserV1Select |
Default value: All Example value: Email, BusinessGroupId Unique items |
| Sort |
Sort records Sort by the first column, then by the second column, and so on |
Collection of ListAppUserV1Sort |
Default value: Email Example value: Email Max items: 3 Unique items |
| PageNumber |
Page number |
integer (32 bits) |
Default value: 1 Example value: 1 Range: inclusive between 1 and 2147483647 |
| PageSize |
Number of records per page |
integer (32 bits) |
Default value: 10 Example value: 10 Range: inclusive between 0 and 100 |
Body Parameters
None.
Response Information
Resource Description
Retrieve a list of app users
ListAppUserV1Response| Name | Description | Type | Additional information |
|---|---|---|---|
| AppUsers |
List of app users |
Collection of ListAppUserV1ResponseAppUser |
None. |
| Total |
Total number of records matching the request |
integer (32 bits) |
Required Example value: 42 Range: inclusive between 0 and 2147483647 |
Response Formats
application/json
Sample:
{
"AppUsers": [
{
"AppUserId": "078c75c2-1fcc-4070-a8ea-30146bf6e652",
"Email": "example@email",
"BusinessGroupId": "b020170d-743d-483b-b455-99812413d41d",
"CreateDate": "2018-12-31T21:59:59.999+00:00",
"LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
},
{
"AppUserId": "078c75c2-1fcc-4070-a8ea-30146bf6e652",
"Email": "example@email",
"BusinessGroupId": "b020170d-743d-483b-b455-99812413d41d",
"CreateDate": "2018-12-31T21:59:59.999+00:00",
"LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
}
],
"Total": 42
}