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": "53cac7f6-e6ab-48aa-9770-17e9195196e6", "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": "a2c6d23c-3165-4daa-be0d-4067b9c324a1", "Teams": [ { "TeamId": "9c338be7-1f2f-4e61-b388-f303976195f6", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "738c8bc2-521d-4a1a-bb28-042a87c14888", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T11:51:40.1880454-08:00", "MeasurementValueNeededDate": "2023-12-01T11:51:40.1880454-08:00", "SourceSystemId": "sample string 3", "CompanyId": "ef6da76e-c54a-4a01-a641-206e19469e64", "CreateDate": "2023-12-01T11:51:40.1880454-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T11:51:40.1880454-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "738c8bc2-521d-4a1a-bb28-042a87c14888", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T11:51:40.1880454-08:00", "MeasurementValueNeededDate": "2023-12-01T11:51:40.1880454-08:00", "SourceSystemId": "sample string 3", "CompanyId": "ef6da76e-c54a-4a01-a641-206e19469e64", "CreateDate": "2023-12-01T11:51:40.1880454-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T11:51:40.1880454-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "c993544b-5d4e-4391-83cb-ce6b0573a85b", "CreateDate": "2023-12-01T11:51:40.1880454-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T11:51:40.1880454-08:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "9c338be7-1f2f-4e61-b388-f303976195f6", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "738c8bc2-521d-4a1a-bb28-042a87c14888", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T11:51:40.1880454-08:00", "MeasurementValueNeededDate": "2023-12-01T11:51:40.1880454-08:00", "SourceSystemId": "sample string 3", "CompanyId": "ef6da76e-c54a-4a01-a641-206e19469e64", "CreateDate": "2023-12-01T11:51:40.1880454-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T11:51:40.1880454-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "738c8bc2-521d-4a1a-bb28-042a87c14888", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T11:51:40.1880454-08:00", "MeasurementValueNeededDate": "2023-12-01T11:51:40.1880454-08:00", "SourceSystemId": "sample string 3", "CompanyId": "ef6da76e-c54a-4a01-a641-206e19469e64", "CreateDate": "2023-12-01T11:51:40.1880454-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T11:51:40.1880454-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "c993544b-5d4e-4391-83cb-ce6b0573a85b", "CreateDate": "2023-12-01T11:51:40.1880454-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T11:51:40.1880454-08:00", "LastModifiedUser": "sample string 6" } ] }, { "UserId": "53cac7f6-e6ab-48aa-9770-17e9195196e6", "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": "a2c6d23c-3165-4daa-be0d-4067b9c324a1", "Teams": [ { "TeamId": "9c338be7-1f2f-4e61-b388-f303976195f6", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "738c8bc2-521d-4a1a-bb28-042a87c14888", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T11:51:40.1880454-08:00", "MeasurementValueNeededDate": "2023-12-01T11:51:40.1880454-08:00", "SourceSystemId": "sample string 3", "CompanyId": "ef6da76e-c54a-4a01-a641-206e19469e64", "CreateDate": "2023-12-01T11:51:40.1880454-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T11:51:40.1880454-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "738c8bc2-521d-4a1a-bb28-042a87c14888", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T11:51:40.1880454-08:00", "MeasurementValueNeededDate": "2023-12-01T11:51:40.1880454-08:00", "SourceSystemId": "sample string 3", "CompanyId": "ef6da76e-c54a-4a01-a641-206e19469e64", "CreateDate": "2023-12-01T11:51:40.1880454-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T11:51:40.1880454-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "c993544b-5d4e-4391-83cb-ce6b0573a85b", "CreateDate": "2023-12-01T11:51:40.1880454-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T11:51:40.1880454-08:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "9c338be7-1f2f-4e61-b388-f303976195f6", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "738c8bc2-521d-4a1a-bb28-042a87c14888", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T11:51:40.1880454-08:00", "MeasurementValueNeededDate": "2023-12-01T11:51:40.1880454-08:00", "SourceSystemId": "sample string 3", "CompanyId": "ef6da76e-c54a-4a01-a641-206e19469e64", "CreateDate": "2023-12-01T11:51:40.1880454-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T11:51:40.1880454-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "738c8bc2-521d-4a1a-bb28-042a87c14888", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T11:51:40.1880454-08:00", "MeasurementValueNeededDate": "2023-12-01T11:51:40.1880454-08:00", "SourceSystemId": "sample string 3", "CompanyId": "ef6da76e-c54a-4a01-a641-206e19469e64", "CreateDate": "2023-12-01T11:51:40.1880454-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T11:51:40.1880454-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "c993544b-5d4e-4391-83cb-ce6b0573a85b", "CreateDate": "2023-12-01T11:51:40.1880454-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T11:51:40.1880454-08:00", "LastModifiedUser": "sample string 6" } ] } ], "Total": 1, "Message": "sample string 1" }