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": "065c822d-52f4-443d-b1a5-109b751a63d2",
"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": "bc63fef6-bb99-4665-aaee-cd67b2bed20b",
"Teams": [
{
"TeamId": "26e746d2-9748-4469-ad60-ee2262f82b79",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "c208e630-7787-4d49-ad99-bc612009fcbf",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-08T09:47:59.1482362-08:00",
"MeasurementValueNeededDate": "2024-12-08T09:47:59.1482362-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5352b992-e8ba-46cb-9172-8e35c3dbc170",
"CreateDate": "2024-12-08T09:47:59.1482362-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T09:47:59.1482362-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "c208e630-7787-4d49-ad99-bc612009fcbf",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-08T09:47:59.1482362-08:00",
"MeasurementValueNeededDate": "2024-12-08T09:47:59.1482362-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5352b992-e8ba-46cb-9172-8e35c3dbc170",
"CreateDate": "2024-12-08T09:47:59.1482362-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T09:47:59.1482362-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "20604cea-f78e-4918-9bbc-0e58a1c3b1a2",
"CreateDate": "2024-12-08T09:47:59.1482362-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T09:47:59.1482362-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "26e746d2-9748-4469-ad60-ee2262f82b79",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "c208e630-7787-4d49-ad99-bc612009fcbf",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-08T09:47:59.1482362-08:00",
"MeasurementValueNeededDate": "2024-12-08T09:47:59.1482362-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5352b992-e8ba-46cb-9172-8e35c3dbc170",
"CreateDate": "2024-12-08T09:47:59.1482362-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T09:47:59.1482362-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "c208e630-7787-4d49-ad99-bc612009fcbf",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-08T09:47:59.1482362-08:00",
"MeasurementValueNeededDate": "2024-12-08T09:47:59.1482362-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5352b992-e8ba-46cb-9172-8e35c3dbc170",
"CreateDate": "2024-12-08T09:47:59.1482362-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T09:47:59.1482362-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "20604cea-f78e-4918-9bbc-0e58a1c3b1a2",
"CreateDate": "2024-12-08T09:47:59.1482362-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T09:47:59.1482362-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
{
"UserId": "065c822d-52f4-443d-b1a5-109b751a63d2",
"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": "bc63fef6-bb99-4665-aaee-cd67b2bed20b",
"Teams": [
{
"TeamId": "26e746d2-9748-4469-ad60-ee2262f82b79",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "c208e630-7787-4d49-ad99-bc612009fcbf",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-08T09:47:59.1482362-08:00",
"MeasurementValueNeededDate": "2024-12-08T09:47:59.1482362-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5352b992-e8ba-46cb-9172-8e35c3dbc170",
"CreateDate": "2024-12-08T09:47:59.1482362-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T09:47:59.1482362-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "c208e630-7787-4d49-ad99-bc612009fcbf",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-08T09:47:59.1482362-08:00",
"MeasurementValueNeededDate": "2024-12-08T09:47:59.1482362-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5352b992-e8ba-46cb-9172-8e35c3dbc170",
"CreateDate": "2024-12-08T09:47:59.1482362-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T09:47:59.1482362-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "20604cea-f78e-4918-9bbc-0e58a1c3b1a2",
"CreateDate": "2024-12-08T09:47:59.1482362-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T09:47:59.1482362-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "26e746d2-9748-4469-ad60-ee2262f82b79",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "c208e630-7787-4d49-ad99-bc612009fcbf",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-08T09:47:59.1482362-08:00",
"MeasurementValueNeededDate": "2024-12-08T09:47:59.1482362-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5352b992-e8ba-46cb-9172-8e35c3dbc170",
"CreateDate": "2024-12-08T09:47:59.1482362-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T09:47:59.1482362-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "c208e630-7787-4d49-ad99-bc612009fcbf",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-08T09:47:59.1482362-08:00",
"MeasurementValueNeededDate": "2024-12-08T09:47:59.1482362-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5352b992-e8ba-46cb-9172-8e35c3dbc170",
"CreateDate": "2024-12-08T09:47:59.1482362-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T09:47:59.1482362-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "20604cea-f78e-4918-9bbc-0e58a1c3b1a2",
"CreateDate": "2024-12-08T09:47:59.1482362-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-08T09:47:59.1482362-08:00",
"LastModifiedUser": "sample string 6"
}
]
}
],
"Total": 1,
"Message": "sample string 1"
}