Groups

Manage groups within a workspace

List groups of a workspace

get

Returns all groups of the workspace. Requires administrator rights.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Responses

200

List of groups

application/json

total_countintegerOptional

total_pagesintegerOptional

server_timeinteger · int64Optional

get/{app_short}/groups

HTTPcURLJavaScriptPython

GET /{app_short}/groups HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

List of groups

{
  "groups": [
    {
      "is_system": true,
      "id": 1,
      "name": "text",
      "description": "text",
      "user_ids": [
        1
      ],
      "structure_ids": [
        1
      ]
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "server_time": 1
}

Create a group

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Body

application/json

Body for creating or updating a group

namestringRequired

Group name

descriptionstringRequired

Group description

user_idsinteger[]Optional

Identifiers of users in the group

structure_idsinteger[]Optional

Identifiers of forms in the group

Responses

200

Group created

application/json

Group within a workspace

is_systembooleanOptional

Whether this is a system group

idintegerOptional

Group identifier

namestringOptional

Displayed name

descriptionstringOptional

Description set by the administrator

user_idsinteger[]Optional

Identifiers of users in the group

structure_idsinteger[]Optional

Identifiers of forms linked to the group

post/{app_short}/group

HTTPcURLJavaScriptPython

POST /{app_short}/group HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "name": "text",
  "description": "text",
  "user_ids": [
    1
  ],
  "structure_ids": [
    1
  ]
}

200

Group created

{
  "is_system": true,
  "id": 1,
  "name": "text",
  "description": "text",
  "user_ids": [
    1
  ],
  "structure_ids": [
    1
  ]
}

Update a group

put

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

group_idintegerRequired

Group identifier

Body

application/json

Body for creating or updating a group

namestringRequired

Group name

descriptionstringRequired

Group description

user_idsinteger[]Optional

Identifiers of users in the group

structure_idsinteger[]Optional

Identifiers of forms in the group

Responses

200

Group updated

application/json

Group within a workspace

is_systembooleanOptional

Whether this is a system group

idintegerOptional

Group identifier

namestringOptional

Displayed name

descriptionstringOptional

Description set by the administrator

user_idsinteger[]Optional

Identifiers of users in the group

structure_idsinteger[]Optional

Identifiers of forms linked to the group

put/{app_short}/group/{group_id}

HTTPcURLJavaScriptPython

PUT /{app_short}/group/{group_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "name": "text",
  "description": "text",
  "user_ids": [
    1
  ],
  "structure_ids": [
    1
  ]
}

200

Group updated

{
  "is_system": true,
  "id": 1,
  "name": "text",
  "description": "text",
  "user_ids": [
    1
  ],
  "structure_ids": [
    1
  ]
}