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 DataFilter |
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": "720662a8-35ac-41e5-b64f-740eb1057c74",
"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": "4a0771e6-c555-46d6-9a1a-0e6de4d8bae2",
"Profiles": [
{
"ProfileId": "e9a6d25d-8cd8-4958-a64d-e4ed1c73edf0",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "b4a365ad-bda3-42a7-9d10-daab31cdd99d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2021-04-17T07:48:03.6350373-07:00",
"MeasurementValueNeededDate": "2021-04-17T07:48:03.6350373-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "eecbf8e0-3ebe-4b69-9af7-57547e273ac1",
"CreateDate": "2021-04-17T07:48:03.6350373-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:48:03.6350373-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
{
"AssetGroupId": "b4a365ad-bda3-42a7-9d10-daab31cdd99d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2021-04-17T07:48:03.6350373-07:00",
"MeasurementValueNeededDate": "2021-04-17T07:48:03.6350373-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "eecbf8e0-3ebe-4b69-9af7-57547e273ac1",
"CreateDate": "2021-04-17T07:48:03.6350373-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:48:03.6350373-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "29b4b802-d822-49d3-9c11-b5b7288c1828",
"CreateDate": "2021-04-17T07:48:03.6350373-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:48:03.6350373-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
{
"ProfileId": "e9a6d25d-8cd8-4958-a64d-e4ed1c73edf0",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "b4a365ad-bda3-42a7-9d10-daab31cdd99d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2021-04-17T07:48:03.6350373-07:00",
"MeasurementValueNeededDate": "2021-04-17T07:48:03.6350373-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "eecbf8e0-3ebe-4b69-9af7-57547e273ac1",
"CreateDate": "2021-04-17T07:48:03.6350373-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:48:03.6350373-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
{
"AssetGroupId": "b4a365ad-bda3-42a7-9d10-daab31cdd99d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2021-04-17T07:48:03.6350373-07:00",
"MeasurementValueNeededDate": "2021-04-17T07:48:03.6350373-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "eecbf8e0-3ebe-4b69-9af7-57547e273ac1",
"CreateDate": "2021-04-17T07:48:03.6350373-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:48:03.6350373-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "29b4b802-d822-49d3-9c11-b5b7288c1828",
"CreateDate": "2021-04-17T07:48:03.6350373-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:48:03.6350373-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
}
]
},
{
"UserId": "720662a8-35ac-41e5-b64f-740eb1057c74",
"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": "4a0771e6-c555-46d6-9a1a-0e6de4d8bae2",
"Profiles": [
{
"ProfileId": "e9a6d25d-8cd8-4958-a64d-e4ed1c73edf0",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "b4a365ad-bda3-42a7-9d10-daab31cdd99d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2021-04-17T07:48:03.6350373-07:00",
"MeasurementValueNeededDate": "2021-04-17T07:48:03.6350373-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "eecbf8e0-3ebe-4b69-9af7-57547e273ac1",
"CreateDate": "2021-04-17T07:48:03.6350373-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:48:03.6350373-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
{
"AssetGroupId": "b4a365ad-bda3-42a7-9d10-daab31cdd99d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2021-04-17T07:48:03.6350373-07:00",
"MeasurementValueNeededDate": "2021-04-17T07:48:03.6350373-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "eecbf8e0-3ebe-4b69-9af7-57547e273ac1",
"CreateDate": "2021-04-17T07:48:03.6350373-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:48:03.6350373-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "29b4b802-d822-49d3-9c11-b5b7288c1828",
"CreateDate": "2021-04-17T07:48:03.6350373-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:48:03.6350373-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
{
"ProfileId": "e9a6d25d-8cd8-4958-a64d-e4ed1c73edf0",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "b4a365ad-bda3-42a7-9d10-daab31cdd99d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2021-04-17T07:48:03.6350373-07:00",
"MeasurementValueNeededDate": "2021-04-17T07:48:03.6350373-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "eecbf8e0-3ebe-4b69-9af7-57547e273ac1",
"CreateDate": "2021-04-17T07:48:03.6350373-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:48:03.6350373-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
{
"AssetGroupId": "b4a365ad-bda3-42a7-9d10-daab31cdd99d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2021-04-17T07:48:03.6350373-07:00",
"MeasurementValueNeededDate": "2021-04-17T07:48:03.6350373-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "eecbf8e0-3ebe-4b69-9af7-57547e273ac1",
"CreateDate": "2021-04-17T07:48:03.6350373-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:48:03.6350373-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "29b4b802-d822-49d3-9c11-b5b7288c1828",
"CreateDate": "2021-04-17T07:48:03.6350373-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:48:03.6350373-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
}
]
}
],
"Total": 1,
"Message": "sample string 1"
}