Groups

Page description

List groups

get

List groups in the same workspace.

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · min: 1 · max: 9007199254740991Optional

Which page to fetch

Default: 1

pageSizeinteger · min: 1 · max: 30Optional

Page size to use

Default: 30

statusstring · enumOptional

Group status

Possible values:

sortBystring · enumOptional

Sort by attribute

Default: createdAtPossible values:

sortOrderstring · enumOptional

Sort order

Default: ascPossible values:

Responses

200

Successful response

application/json

pagenumberRequired

Current page

nextany ofRequired

Next page or null if there is none

numberOptional

or

nullOptional

prevany ofRequired

Previous page or null if there is none

numberOptional

or

nullOptional

pageSizenumberRequired

Max count of items per page

totalnumberRequired

Total count of items

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/groups

HTTPcURLJavaScriptPython

GET /v1/rest/groups HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "next": 1,
  "prev": 1,
  "pageSize": 1,
  "total": 1,
  "results": [
    {
      "id": "text",
      "legacyId": 1,
      "name": "text",
      "description": "text",
      "status": "ACTIVE",
      "members": [
        {
          "id": "text",
          "legacyId": 1,
          "legacyViewAll": true,
          "workspaceName": "text",
          "name": "text",
          "deviceUserId": "text",
          "deviceType": "PSD",
          "role": "ADMIN",
          "pubKey": "text",
          "status": "ACTIVE",
          "isSuspended": true,
          "createdAt": "text",
          "updatedAt": "text"
        }
      ],
      "createdAt": "text",
      "updatedAt": "text"
    }
  ]
}

Get a single group

get

Find a group by ID.

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the target group

Responses

200

Successful response

application/json

idstringRequired

Internal unique identifier

legacyIdnumberRequired

Legacy internal unique identifier (for retro-compatibility)

namestringRequired

Group name

descriptionany ofRequired

Group description

stringOptional

or

nullOptional

statusstring · enumRequired

Group status

Possible values:

createdAtstringRequired

Creation timestamp

updatedAtstringRequired

Last modification timestamp

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/groups/{id}

HTTPcURLJavaScriptPython

GET /v1/rest/groups/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "legacyId": 1,
  "name": "text",
  "description": "text",
  "status": "ACTIVE",
  "members": [
    {
      "id": "text",
      "legacyId": 1,
      "legacyViewAll": true,
      "workspaceName": "text",
      "name": "text",
      "deviceUserId": "text",
      "deviceType": "PSD",
      "role": "ADMIN",
      "pubKey": "text",
      "status": "ACTIVE",
      "isSuspended": true,
      "createdAt": "text",
      "updatedAt": "text"
    }
  ],
  "createdAt": "text",
  "updatedAt": "text"
}