NodeRings Docs

List Groups

GET
/v1/groups
Authorization<token>

Bearer token

In: header

X-Organization-ID<token>

Tenant or organization identifier

In: header

Query Parameters

page?integer
Formatint32
pageSize?integer
Formatint32
filterName?string
filterStatus?string
Value in"STATUS_UNSPECIFIED" | "STATUS_ACTIVE" | "STATUS_INACTIVE" | "STATUS_BANNED" | "STATUS_SOFT_DELETED"
search?string

Response Body

application/json

curl -X GET "https://api.nrings.io/v1/groups?page&pageSize&filterName&filterStatus&search" \  -H "Authorization: Bearer {your_token}" \  -H "X-Organization-ID: {your_org_id}"
{
  "groups": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "groupRoles": [
        "string"
      ],
      "userEmails": [
        "string"
      ],
      "metadata": {},
      "status": "STATUS_UNSPECIFIED",
      "timestamps": {
        "createTime": "2019-08-24T14:15:22Z",
        "updateTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "totalCount": 0
}