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": "592612b3-8355-4c1f-bddd-6bca8b6037d9",
"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": "ea14aa86-9048-4f5b-9b64-20464ba404a7",
"Teams": [
{
"TeamId": "8049171e-8e44-4489-93a6-1feb49932b91",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "b8617515-0b4a-41f7-8a81-e44d69c27556",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-03-18T16:44:26.0121398-07:00",
"MeasurementValueNeededDate": "2025-03-18T16:44:26.0121398-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b7305925-46c4-4d38-a278-77ea781f34bf",
"CreateDate": "2025-03-18T16:44:26.0121398-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T16:44:26.0121398-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "b8617515-0b4a-41f7-8a81-e44d69c27556",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-03-18T16:44:26.0121398-07:00",
"MeasurementValueNeededDate": "2025-03-18T16:44:26.0121398-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b7305925-46c4-4d38-a278-77ea781f34bf",
"CreateDate": "2025-03-18T16:44:26.0121398-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T16:44:26.0121398-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "eed7f34c-6fc6-4011-a049-aaff94a281ef",
"CreateDate": "2025-03-18T16:44:26.0121398-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T16:44:26.0121398-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "8049171e-8e44-4489-93a6-1feb49932b91",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "b8617515-0b4a-41f7-8a81-e44d69c27556",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-03-18T16:44:26.0121398-07:00",
"MeasurementValueNeededDate": "2025-03-18T16:44:26.0121398-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b7305925-46c4-4d38-a278-77ea781f34bf",
"CreateDate": "2025-03-18T16:44:26.0121398-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T16:44:26.0121398-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "b8617515-0b4a-41f7-8a81-e44d69c27556",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-03-18T16:44:26.0121398-07:00",
"MeasurementValueNeededDate": "2025-03-18T16:44:26.0121398-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b7305925-46c4-4d38-a278-77ea781f34bf",
"CreateDate": "2025-03-18T16:44:26.0121398-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T16:44:26.0121398-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "eed7f34c-6fc6-4011-a049-aaff94a281ef",
"CreateDate": "2025-03-18T16:44:26.0121398-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T16:44:26.0121398-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
{
"UserId": "592612b3-8355-4c1f-bddd-6bca8b6037d9",
"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": "ea14aa86-9048-4f5b-9b64-20464ba404a7",
"Teams": [
{
"TeamId": "8049171e-8e44-4489-93a6-1feb49932b91",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "b8617515-0b4a-41f7-8a81-e44d69c27556",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-03-18T16:44:26.0121398-07:00",
"MeasurementValueNeededDate": "2025-03-18T16:44:26.0121398-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b7305925-46c4-4d38-a278-77ea781f34bf",
"CreateDate": "2025-03-18T16:44:26.0121398-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T16:44:26.0121398-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "b8617515-0b4a-41f7-8a81-e44d69c27556",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-03-18T16:44:26.0121398-07:00",
"MeasurementValueNeededDate": "2025-03-18T16:44:26.0121398-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b7305925-46c4-4d38-a278-77ea781f34bf",
"CreateDate": "2025-03-18T16:44:26.0121398-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T16:44:26.0121398-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "eed7f34c-6fc6-4011-a049-aaff94a281ef",
"CreateDate": "2025-03-18T16:44:26.0121398-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T16:44:26.0121398-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "8049171e-8e44-4489-93a6-1feb49932b91",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "b8617515-0b4a-41f7-8a81-e44d69c27556",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-03-18T16:44:26.0121398-07:00",
"MeasurementValueNeededDate": "2025-03-18T16:44:26.0121398-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b7305925-46c4-4d38-a278-77ea781f34bf",
"CreateDate": "2025-03-18T16:44:26.0121398-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T16:44:26.0121398-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "b8617515-0b4a-41f7-8a81-e44d69c27556",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-03-18T16:44:26.0121398-07:00",
"MeasurementValueNeededDate": "2025-03-18T16:44:26.0121398-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b7305925-46c4-4d38-a278-77ea781f34bf",
"CreateDate": "2025-03-18T16:44:26.0121398-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T16:44:26.0121398-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "eed7f34c-6fc6-4011-a049-aaff94a281ef",
"CreateDate": "2025-03-18T16:44:26.0121398-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-18T16:44:26.0121398-07:00",
"LastModifiedUser": "sample string 6"
}
]
}
],
"Total": 1,
"Message": "sample string 1"
}