CRUD
WorkspaceGroups

Retrieve or search workspace groups

Returns all workspace groups or searches workspace groups by query. Always returns only workspace groups which are accessible by the current user.<br/>Requirements:<br/>- auth-client scopes: "workspace:read"<br/>- user permission: "read" or higher

post/api/workspaces/groups/search

Request

  • Base URL: https://app.airfocus.com
  • URL: https://app.airfocus.com/api/workspaces/groups/search
  • 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.

offsetinteger

How many elements to skip.

limitinteger

How many elements to return.

frominteger

From which element the page should start.

tointeger

At which element the page should end (excluding it).

Request body

WorkspaceGroupSearchQuery required

Response

totalItemsinteger required

Example response

{
  "items": [
    {
      "_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.