Groups
Guardian Groups Endpoints.
Groups
/groups
GET https://explorer.protokol.sh/api/guardian/groups
Returns all Groups
Query Parameters
page
integer
The number of a page that will be returned
limit
integer
The number of resources per page
orderBy
string
Type by which it should order resources. Example: orderBy=name:asc
name
string
Value by which it should search for resources (allows wildcard %)
priority
integer
Value by which should search for resources
active
boolean
Value by which should search for resources
default
boolean
Value by which should search for resources
{
"meta": {
"totalCountIsEstimate": false,
"count": 2,
"pageCount": 1,
"totalCount": 2,
"next": null,
"previous": null,
"self": "/guardian/groups?page=1&limit=100",
"first": "/guardian/groups?page=1&limit=100",
"last": "/guardian/groups?page=1&limit=100"
},
"data": [
{
"name": "Test Guardian Permission Group",
"priority": 1,
"active": true,
"default": false,
"allow": [
{
"transactionType": 1,
"transactionTypeGroup": 1
}
],
"deny": [
{
"transactionType": 2,
"transactionTypeGroup": 1
}
]
},
{
"name": "Test Guardian Permission Group2",
"priority": 1,
"active": true,
"default": false,
"allow": [
{
"transactionType": 1,
"transactionTypeGroup": 1
}
],
"deny": [
{
"transactionType": 2,
"transactionTypeGroup": 1
}
]
}
]
}Examples
Group By Name
/groups/:name
GET https://explorer.protokol.sh/api/guardian/groups/:name
Returns Group by name
Path Parameters
name
string
The name of the group
Examples
Users By Group Name
/groups/:name/users
GET https://explorer.protokol.sh/api/guardian/groups/:name/users
Returns users of specific group by name
Path Parameters
name
string
The name of the group
Examples
Last updated
Was this helpful?