Groups
Multisigner Groups (v1.0.0)
Download OpenAPI specification:Download
API Documentation for Multisigner Groups
GroupInfo
GroupInfo queries group info based on group id.
Authorizations:
path Parameters
| group_id required | integer or string <int64> (group_id) group_id is the unique ID of the group. |
Responses
Response samples
- 200
{- "info": {
- "id": 0,
- "admin": "string",
- "metadata": "string",
- "version": 0,
- "totalWeight": "string",
- "createdAt": "2023-01-15T01:30:15.01Z"
}
}Groups
Groups queries all groups in state.
Since: cosmos-sdk 0.47.1
Authorizations:
query Parameters
| pagination.key | string <byte> (key) key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | integer or string <int64> (offset) offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | integer or string <int64> (limit) limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.countTotal | boolean (count_total) count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean (reverse) reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Response samples
- 200
{- "groups": [
- {
- "id": 0,
- "admin": "string",
- "metadata": "string",
- "version": 0,
- "totalWeight": "string",
- "createdAt": "2023-01-15T01:30:15.01Z"
}
], - "pagination": {
- "nextKey": "string",
- "total": 0
}
}GroupsByAdmin
GroupsByAdmin queries groups by admin address.
Authorizations:
path Parameters
| admin required | string (admin) admin is the account address of a group's admin. |
query Parameters
| pagination.key | string <byte> (key) key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | integer or string <int64> (offset) offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | integer or string <int64> (limit) limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.countTotal | boolean (count_total) count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean (reverse) reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Response samples
- 200
{- "groups": [
- {
- "id": 0,
- "admin": "string",
- "metadata": "string",
- "version": 0,
- "totalWeight": "string",
- "createdAt": "2023-01-15T01:30:15.01Z"
}
], - "pagination": {
- "nextKey": "string",
- "total": 0
}
}GroupsByMember
GroupsByMember queries groups by member address.
Authorizations:
path Parameters
| address required | string (address) address is the group member address. |
query Parameters
| pagination.key | string <byte> (key) key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | integer or string <int64> (offset) offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | integer or string <int64> (limit) limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.countTotal | boolean (count_total) count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean (reverse) reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Response samples
- 200
{- "groups": [
- {
- "id": 0,
- "admin": "string",
- "metadata": "string",
- "version": 0,
- "totalWeight": "string",
- "createdAt": "2023-01-15T01:30:15.01Z"
}
], - "pagination": {
- "nextKey": "string",
- "total": 0
}
}