Groups

Manage groups within a workspace

List the groups of a workspace

get

Authorizations

OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

---

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:

Path parameters

app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

Query parameters

pagestringOptional

Page of the overview.

Default: 0Pattern: \d+

per_pagestringOptional

Number of result by page (Max 100)

Default: 10Pattern: -?\d+

include_systemstringOptional

Include system groups

Default: false

Header parameters

X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:

Responses

200

Paginated list of groups

application/json

total_countintegerOptional

total_pagesintegerOptional

server_timeintegerOptional

401

Missing or invalid access token.

application/json

get/{app_short}/groups

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

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

Create a group

post

Authorizations

OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

---

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:

Path parameters

app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

Header parameters

X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:

Body

Body for creating or updating a group

descriptionstringRequired

Group description

namestringRequired

Group name

structure_idsinteger[]Optional

Identifiers of forms in the group

user_idsinteger[]Optional

Identifiers of users in the group

Responses

200

Group created

application/json

Group within a workspace

descriptionstringOptional

Description set by the administrator

idintegerOptional

Group identifier

is_systembooleanOptional

Whether this is a system group

namestringOptional

Displayed name

structure_idsinteger[]Optional

Identifiers of forms linked to the group. Only computed when creating or updating a group; always an empty array on the list endpoint (GET /groups never populates it).

user_idsinteger[]Optional

Identifiers of users in the group. Only computed when creating or updating a group; always an empty array on the list endpoint (GET /groups never populates it).

400

The payload is invalid.

application/json

401

Missing or invalid access token.

application/json

post/{app_short}/group

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

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

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

Update a group

put

Authorizations

OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

---

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:

Path parameters

app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

group_idstringRequiredPattern: \d+

Header parameters

X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:

Body

Body for creating or updating a group

descriptionstringRequired

Group description

namestringRequired

Group name

structure_idsinteger[]Optional

Identifiers of forms in the group

user_idsinteger[]Optional

Identifiers of users in the group

Responses

200

Group updated

application/json

Group within a workspace

descriptionstringOptional

Description set by the administrator

idintegerOptional

Group identifier

is_systembooleanOptional

Whether this is a system group

namestringOptional

Displayed name

structure_idsinteger[]Optional

Identifiers of forms linked to the group. Only computed when creating or updating a group; always an empty array on the list endpoint (GET /groups never populates it).

user_idsinteger[]Optional

Identifiers of users in the group. Only computed when creating or updating a group; always an empty array on the list endpoint (GET /groups never populates it).

401

Missing or invalid access token.

application/json

404

No group with this identifier in the workspace.

application/json

put/{app_short}/group/{group_id}

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

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

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