Search Users
Last updated
Last updated
Use the following parameters to search users.
Returns objects created in the provided account.
null
Returns objects created after the entered date.
null
Example: 2020-09-12T14:15:22Z
Returns objects created before the entered date.
null
Example: 2020-12-13T16:17:28Z
Lists users who belong to the entered groups.
null
Returns the object corresponding to the entered ID
null
Orders the list of results
null
Example: desc
Possible values: criteria to order by
null
Example: name
Defines the page number to be fetched.
1
Example: 3
Defines the number of elements displayed on a page. Must be a positive number with 0 and -1 return a maximum defined in the gate
20
Example: 40
Returns object who hold the selected user role.
null
Possible values: Returns users who match the selected status.
null
Possible values: Returns the object who has the entered username.
null
GET /users HTTP/1.1
Host:
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*
{
"edges": [
{
"cursor": 0,
"node": {
"created_by": 5,
"created_on": "2025-06-20T17:35:11.371Z",
"id": 1,
"is_api": false,
"key_handle": "7920380c812ab0b752b5f04a2561a736f136d9937af542bce149bad075ee25f60f21dad3fa9a8a88bc3fa80a360b3680bb7e1ef6179701e41f9d90fd5f6b475d",
"last_request": 2,
"pub_key": "040BAE7B34D9AB3056D575128F24B42D09705FF9CFCD860790DF8147D45888E4C8C9C19AE837298C45CBC595152EA5F43788431F6B4C0017030351C05F6C505FCA",
"role": "OPERATOR",
"status": "ACTIVE",
"user_id": "5CA88C5165CF3640",
"username": "operator1"
}
}
],
"page_info": {
"count": 1,
"has_next_page": false
}
}