Workspaces

Retrieve a single workspace by its alias (e.g. 'DEV').

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

get/api/workspaces/alias/{aliasValue}

Request

  • Base URL: https://app.airfocus.com
  • URL: https://app.airfocus.com/api/workspaces/alias/{aliasValue}
  • Auth: HTTP bearer

Path parameters

aliasValuestring required

Query parameters

actAsAdminboolean

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

Response

aliasstring

A custom code of this workspace (e.g. PROD, DEV, etc), which is used to create aliases for items (e.g. DEV-123). Alias should consist of 1-10 uppercase letters, and should be unique within the team.

createdAtstring date-time required

Timestamp of when this workspace was created.

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

Unique identifier of this workspace.

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 required

Timestamp of when any entities related to this workspace were last changed.

lastUpdatedAtstring date-time required

Timestamp of when this workspace was last updated.

namestring required

Name of this workspace.

namespace'main' | 'app:okr' | 'app:portfolio' required
orderinteger required

Order number of this workspace for sorting.

progressMode'count' | 'none' | 'percentage' required
statusPresetIdstring uuid

Optional reference to a shared status preset. When set, statuses are read from the preset instead of workspace-specific statuses.

teamIdstring uuid required

Id of the team this workspace belongs to.

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.