Workspaces

Retrieve multiple workspaces by their IDs with optional partial embed.

Returns workspaces for the provided IDs. Use the embed field to select which embedded properties to include — only those are fetched, minimising DB round trips. Preserves order & returns null for IDs that are not found or inaccessible.<br/>Requirements:<br/>- auth-client scopes: "workspace:read"<br/>- user permission: "read" or higher

post/api/workspaces/list/partial

Request

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

idsstring[] required

Response

aliasstring
archivedboolean
createdAtstring date-time
defaultPermission'comment' | 'full' | 'read' | 'write'
idstring uuid required
itemColor'amber' | 'azure' | 'black' | 'blue' | 'coco' | 'daulphine' | 'emerald' | 'fanta' | 'granite' | 'great' | 'leaf' | 'moss' | 'mutedAmber' | 'mutedAzure' | 'mutedBlack' | 'mutedBlue' | 'mutedCoco' | 'mutedDaulphine' | 'mutedEmerald' | 'mutedFanta' | 'mutedGranite' | 'mutedGreat' | 'mutedLeaf' | 'mutedMoss' | 'mutedOcean' | 'mutedOrange' | 'mutedPink' | 'mutedPurple' | 'mutedRed' | 'mutedSky' | 'mutedViolet' | 'mutedYellow' | 'ocean' | 'orange' | 'pink' | 'purple' | 'red' | 'sky' | 'violet' | 'yellow'
itemType'bug' | 'epic' | 'experiment' | 'feature' | 'feedback' | 'idea' | 'initiative' | 'app:okr:objective' | 'opportunity' | 'product' | 'project' | 'story' | 'task'
lastActivitystring date-time
lastUpdatedAtstring date-time
namestring
namespace'main' | 'app:okr' | 'app:portfolio'
orderinteger
progressMode'count' | 'none' | 'percentage'
statusPresetIdstring uuid

Example response

[
  {
    "_embedded": {
      "children": [
        {
          "workspace": {
            "description": {
              "blocks": [
                {
                  "content": [
                    {
                      "content": "hello world",
                      "type": "text"
                    }
                  ],
                  "type": "paragraph"
                }
              ],
              "richText": true
            }
          }
        }
      ],
      "parents": [
        {
          "workspace": {
            "description": {
              "blocks": [
                {
                  "content": [
                    {
                      "content": "hello world",
                      "type": "text"
                    }
                  ],
                  "type": "paragraph"
                }
              ],
              "richText": true
            }
          }
        }
      ]
    },
    "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.