Retrieve a single workspace group by its ID

Returns found workspace group.<br/>Requirements:<br/>- auth-client scopes: "workspace:read"<br/>- user permission: "read" or higher

get/api/workspaces/groups/{workspaceGroupId}

Request

Base URL: https://app.airfocus.com
URL: https://app.airfocus.com/api/workspaces/groups/{workspaceGroupId}
Auth: HTTP bearer

Path parameters

workspaceGroupIdstring uuid required

Query parameters

actAsAdminboolean

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

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.