> For the complete documentation index, see [llms.txt](https://www.center.daxium-air.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.center.daxium-air.com/api-reference/groups.md). # Groups Manage groups within a workspace ## GET /{app\_short}/groups > List the groups of a workspace ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"groups"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"Group":{"description":"Group within a workspace","properties":{"description":{"description":"Description set by the administrator","type":"string"},"id":{"description":"Group identifier","type":"integer"},"is_system":{"description":"Whether this is a system group","type":"boolean"},"name":{"description":"Displayed name","type":"string"},"structure_ids":{"description":"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).","type":"array","items":{"type":"integer"}},"user_ids":{"description":"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).","type":"array","items":{"type":"integer"}}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/groups":{"get":{"tags":["groups"],"summary":"List the groups of a workspace","operationId":"listGroups","parameters":[{"name":"page","in":"query","description":"Page of the overview.","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"0","pattern":"\\d+"}},{"name":"per_page","in":"query","description":"Number of result by page (Max 100)","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"10","pattern":"-?\\d+"}},{"name":"include_system","in":"query","description":"Include system groups","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":"false"}},{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"200":{"description":"Paginated list of groups","content":{"application/json":{"schema":{"properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/Group"}},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"server_time":{"type":"integer"}},"type":"object"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## POST /{app\_short}/group > Create a group ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"groups"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"GroupInput":{"description":"Body for creating or updating a group","required":["name","description"],"properties":{"description":{"description":"Group description","type":"string"},"name":{"description":"Group name","type":"string"},"structure_ids":{"description":"Identifiers of forms in the group","type":"array","items":{"type":"integer"}},"user_ids":{"description":"Identifiers of users in the group","type":"array","items":{"type":"integer"}}},"type":"object"},"Group":{"description":"Group within a workspace","properties":{"description":{"description":"Description set by the administrator","type":"string"},"id":{"description":"Group identifier","type":"integer"},"is_system":{"description":"Whether this is a system group","type":"boolean"},"name":{"description":"Displayed name","type":"string"},"structure_ids":{"description":"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).","type":"array","items":{"type":"integer"}},"user_ids":{"description":"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).","type":"array","items":{"type":"integer"}}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/group":{"post":{"tags":["groups"],"summary":"Create a group","operationId":"createGroup","parameters":[{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupInput"}}}},"responses":{"200":{"description":"Group created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"description":"The payload is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## PUT /{app\_short}/group/{group\_id} > Update a group ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"groups"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"GroupInput":{"description":"Body for creating or updating a group","required":["name","description"],"properties":{"description":{"description":"Group description","type":"string"},"name":{"description":"Group name","type":"string"},"structure_ids":{"description":"Identifiers of forms in the group","type":"array","items":{"type":"integer"}},"user_ids":{"description":"Identifiers of users in the group","type":"array","items":{"type":"integer"}}},"type":"object"},"Group":{"description":"Group within a workspace","properties":{"description":{"description":"Description set by the administrator","type":"string"},"id":{"description":"Group identifier","type":"integer"},"is_system":{"description":"Whether this is a system group","type":"boolean"},"name":{"description":"Displayed name","type":"string"},"structure_ids":{"description":"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).","type":"array","items":{"type":"integer"}},"user_ids":{"description":"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).","type":"array","items":{"type":"integer"}}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/group/{group_id}":{"put":{"tags":["groups"],"summary":"Update a group","operationId":"updateGroup","parameters":[{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","pattern":"\\d+"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupInput"}}}},"responses":{"200":{"description":"Group updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"No group with this identifier in the workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://www.center.daxium-air.com/api-reference/groups.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.