GET Users?take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves users for the given parameters. All parameters are optional.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| take |
Number of users to retrieve. Default is all users |
integer |
None. |
| skip |
Number of users to skip before retrieval |
integer |
Default value is 0 |
| sort |
List of sorting rules to describe how to sort the users before retrieval |
Collection of Sort |
None. |
| Operator | string |
None. |
|
| Field | string |
None. |
|
| Value | string |
None. |
|
| Logic | string |
None. |
|
| Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of users.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of User |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"UserId": "8ce0eeca-1951-4a97-bd6a-8ad42898b936",
"UserName": "sample string 1",
"FullName": "sample string 2",
"PhoneNumber": "sample string 3",
"Email": "sample string 4",
"IsLockedOut": true,
"IsApproved": true,
"Role": {
"Name": "sample string 1",
"Description": "sample string 2"
},
"CompanyId": "bb6f8b9f-52be-4ddc-b120-cc15f5613bf9",
"Teams": [
{
"TeamId": "f7725118-909d-49b9-9d01-4072ef3ebc53",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "ebf09934-5fef-4766-be72-7ec5100b7a7d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-20T13:53:44.7784752-08:00",
"MeasurementValueNeededDate": "2026-01-20T13:53:44.7784752-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b6848d9a-9f65-49d3-b0fb-42797e9f60c9",
"CreateDate": "2026-01-20T13:53:44.7784752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-20T13:53:44.7784752-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "ebf09934-5fef-4766-be72-7ec5100b7a7d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-20T13:53:44.7784752-08:00",
"MeasurementValueNeededDate": "2026-01-20T13:53:44.7784752-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b6848d9a-9f65-49d3-b0fb-42797e9f60c9",
"CreateDate": "2026-01-20T13:53:44.7784752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-20T13:53:44.7784752-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "70f470aa-4e4f-412f-9773-a76504bdd78e",
"CreateDate": "2026-01-20T13:53:44.7784752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-20T13:53:44.7784752-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "f7725118-909d-49b9-9d01-4072ef3ebc53",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "ebf09934-5fef-4766-be72-7ec5100b7a7d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-20T13:53:44.7784752-08:00",
"MeasurementValueNeededDate": "2026-01-20T13:53:44.7784752-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b6848d9a-9f65-49d3-b0fb-42797e9f60c9",
"CreateDate": "2026-01-20T13:53:44.7784752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-20T13:53:44.7784752-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "ebf09934-5fef-4766-be72-7ec5100b7a7d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-20T13:53:44.7784752-08:00",
"MeasurementValueNeededDate": "2026-01-20T13:53:44.7784752-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b6848d9a-9f65-49d3-b0fb-42797e9f60c9",
"CreateDate": "2026-01-20T13:53:44.7784752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-20T13:53:44.7784752-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "70f470aa-4e4f-412f-9773-a76504bdd78e",
"CreateDate": "2026-01-20T13:53:44.7784752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-20T13:53:44.7784752-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
{
"UserId": "8ce0eeca-1951-4a97-bd6a-8ad42898b936",
"UserName": "sample string 1",
"FullName": "sample string 2",
"PhoneNumber": "sample string 3",
"Email": "sample string 4",
"IsLockedOut": true,
"IsApproved": true,
"Role": {
"Name": "sample string 1",
"Description": "sample string 2"
},
"CompanyId": "bb6f8b9f-52be-4ddc-b120-cc15f5613bf9",
"Teams": [
{
"TeamId": "f7725118-909d-49b9-9d01-4072ef3ebc53",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "ebf09934-5fef-4766-be72-7ec5100b7a7d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-20T13:53:44.7784752-08:00",
"MeasurementValueNeededDate": "2026-01-20T13:53:44.7784752-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b6848d9a-9f65-49d3-b0fb-42797e9f60c9",
"CreateDate": "2026-01-20T13:53:44.7784752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-20T13:53:44.7784752-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "ebf09934-5fef-4766-be72-7ec5100b7a7d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-20T13:53:44.7784752-08:00",
"MeasurementValueNeededDate": "2026-01-20T13:53:44.7784752-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b6848d9a-9f65-49d3-b0fb-42797e9f60c9",
"CreateDate": "2026-01-20T13:53:44.7784752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-20T13:53:44.7784752-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "70f470aa-4e4f-412f-9773-a76504bdd78e",
"CreateDate": "2026-01-20T13:53:44.7784752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-20T13:53:44.7784752-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "f7725118-909d-49b9-9d01-4072ef3ebc53",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "ebf09934-5fef-4766-be72-7ec5100b7a7d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-20T13:53:44.7784752-08:00",
"MeasurementValueNeededDate": "2026-01-20T13:53:44.7784752-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b6848d9a-9f65-49d3-b0fb-42797e9f60c9",
"CreateDate": "2026-01-20T13:53:44.7784752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-20T13:53:44.7784752-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "ebf09934-5fef-4766-be72-7ec5100b7a7d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-20T13:53:44.7784752-08:00",
"MeasurementValueNeededDate": "2026-01-20T13:53:44.7784752-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b6848d9a-9f65-49d3-b0fb-42797e9f60c9",
"CreateDate": "2026-01-20T13:53:44.7784752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-20T13:53:44.7784752-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "70f470aa-4e4f-412f-9773-a76504bdd78e",
"CreateDate": "2026-01-20T13:53:44.7784752-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-20T13:53:44.7784752-08:00",
"LastModifiedUser": "sample string 6"
}
]
}
],
"Total": 1,
"Message": "sample string 1"
}