Search Group
Use the following parameters to search groups.
Authorizations
Query parameters
created_afterstring · date-time | nullableOptionalDefault:
Returns objects created after the entered date.
null
Example: 2020-09-12T14:15:22Z
created_beforestring · date-time | nullableOptionalDefault:
Returns objects created before the entered date.
null
Example: 2020-12-13T16:17:28Z
descriptionstring | nullableOptionalDefault:
Returns objects that contain the entered description.
null
idinteger | nullableOptionalDefault:
Returns the object corresponding to the entered ID
null
membersinteger[] | nullableOptionalDefault:
Returns ojects that contain the entered member(s).
null
namestring | nullableOptionalDefault:
Returns the object that match the entered name.
null
orderstring · enum | nullableOptionalDefault:
Orders the list of results
null
Example: desc
Possible values: order_bystring | nullableOptionalDefault:
criteria to order by
null
Example: name
pageinteger | nullableOptionalDefault:
Defines the page number to be fetched.
1
Example: 3
page_sizeinteger | nullableOptionalDefault:
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
Responses
200
Group search results
application/json
400
Invalid search parameters
application/json
get
GET /groups HTTP/1.1
Host:
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*
{
"edges": [
{
"cursor": 0,
"node": {
"created_by": 5,
"created_on": "2025-07-01T04:06:22.101Z",
"description": "group of trusted validators",
"id": 1,
"last_request": 3,
"members": [
11,
12
],
"name": "validators",
"status": "ACTIVE"
}
}
],
"page_info": {
"count": 1,
"has_next_page": false
}
}
Last updated