CRUD
WorkspaceGroups

Retrieve multiple workspace groups by their IDs

Returns a list of workspace groups resolved for the provided IDs.<br/> Guarantees that the array-size and order of the returned workspace groups matches the order of requested IDs.<br/> Does not fail if any of the requested workspace groups is not found or not accessible - instead it returns null as an array-element of the corresponding workspace group which could not be accessed.<br/>Requirements:<br/>- auth-client scopes: "workspace:read"<br/>- user permission: "read" or higher

post/api/workspaces/groups/list

Request

  • Base URL: https://app.airfocus.com
  • URL: https://app.airfocus.com/api/workspaces/groups/list
  • Auth: HTTP bearer

Query parameters

actAsAdminboolean

Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.

Request body

string[] required

Response

createdAtstring date-time required

Date-time when this group was created.

defaultPermission'comment' | 'full' | 'read' | 'write'
idstring uuid required

UUID of this group.

lastUpdatedAtstring date-time required

Date-time when this group was last updated.

namestring required

Name of this group.

orderinteger required

Order number of this group for sorting.

parentIdstring uuid

UUID of the parent group (if applicable).

teamIdstring uuid required

UUID of the team which owns this group.

Example response

[
  {
    "_embedded": {
      "workspaces": [
        {
          "description": {
            "blocks": [
              {
                "content": [
                  {
                    "content": "hello world",
                    "type": "text"
                  }
                ],
                "type": "paragraph"
              }
            ],
            "richText": true
          }
        }
      ]
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.