---
title: "Exports a template for given workspaces."
method: POST
path: "/api/templates/export"
tags: ["Templates"]
---

# Exports a template for given workspaces.

`POST /api/templates/export`

## Request

- Base URL: `https://app.airfocus.com`
- URL: `https://app.airfocus.com/api/templates/export`
- Auth: HTTP bearer

Returns an object containing instructions, required for installing such a template.<br/>Requirements:<br/>- auth-client scopes: "workspace:read"<br/>- user permission: "read" or higher

## Query parameters

- `actAsAdmin` boolean

## Request body

- ExportTemplateRequest
  - `exportUsers` boolean: Whether to export user-related data (assignees, people-fields, etc).
  - `exportWorkspaceGroups` boolean: Whether to also export a parent group of the exported workspaces.
  - `workspaceIds` string[], required: A set of workspaces which need to be exported into a template.

## Response `200`

- TemplateInstructions
  - `apps` TemplateInstructionsInstallApp[]
    - `conditions` TemplateInstructionsInstructionCondition[]
      - union
        - TemplateInstructionsInstructionConditionMustHaveFeature
          - `feature` string, required
          - `type` 'mustHaveFeature', required
        - TemplateInstructionsInstructionConditionMustNotHaveFeature
          - `feature` string, required
          - `type` 'mustNotHaveFeature', required
    - `fields` TemplateInstructionsInstallField[]
      - `conditions` TemplateInstructionsInstructionCondition[]
        - union
          - TemplateInstructionsInstructionConditionMustHaveFeature
            - `feature` string, required
            - `type` 'mustHaveFeature', required
          - TemplateInstructionsInstructionConditionMustNotHaveFeature
            - `feature` string, required
            - `type` 'mustNotHaveFeature', required
      - `description` string, required
      - `id` string, uuid, required
      - `isTeamField` boolean, required
      - `name` string, required
      - `settings` unknown, required
      - `typeId` string, required
      - `workspaceIds` string[], required
    - `id` string, uuid, required
    - `settings` unknown, required
    - `typeId` string, required
  - `fields` TemplateInstructionsInstallField[]
    - `conditions` TemplateInstructionsInstructionCondition[]
      - union
        - TemplateInstructionsInstructionConditionMustHaveFeature
          - `feature` string, required
          - `type` 'mustHaveFeature', required
        - TemplateInstructionsInstructionConditionMustNotHaveFeature
          - `feature` string, required
          - `type` 'mustNotHaveFeature', required
    - `description` string, required
    - `id` string, uuid, required
    - `isTeamField` boolean, required
    - `name` string, required
    - `settings` unknown, required
    - `typeId` string, required
    - `workspaceIds` string[], required
  - `itemRelations` TemplateInstructionsCreateItemRelation[]
    - `childId` string, uuid, required
    - `childOrder` integer, required
    - `conditions` TemplateInstructionsInstructionCondition[]
      - union
        - TemplateInstructionsInstructionConditionMustHaveFeature
          - `feature` string, required
          - `type` 'mustHaveFeature', required
        - TemplateInstructionsInstructionConditionMustNotHaveFeature
          - `feature` string, required
          - `type` 'mustNotHaveFeature', required
    - `id` string, uuid, required
    - `parentId` string, uuid, required
    - `parentOrder` integer, required
  - `items` TemplateInstructionsCreateItem[]
    - `assigneeUserIds` string[]
    - `color` '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', required
    - `conditions` TemplateInstructionsInstructionCondition[]
      - union
        - TemplateInstructionsInstructionConditionMustHaveFeature
          - `feature` string, required
          - `type` 'mustHaveFeature', required
        - TemplateInstructionsInstructionConditionMustNotHaveFeature
          - `feature` string, required
          - `type` 'mustNotHaveFeature', required
    - `description` RichText, required
      - `blocks` RichTextBlock[], required
        - union
          - RichTextBlockAttachment
            - `attachmentId` string, uuid, required
            - `caption` string
            - `contentType` string, required
            - `meta` object
            - `type` 'attachment', required
            - `width` integer
          - RichTextBlockBlockquote
            - `content` RichTextInline[], required
              - …
            - `meta` object
            - `type` 'blockquote', required
          - RichTextBlockCode
            - `content` string, required
            - `language` string
            - `meta` object
            - `type` 'code', required
          - RichTextBlockCustom
            - `id` string, required
            - `meta` object
            - `raw` string, required
            - `type` 'custom', required
          - RichTextBlockEmbed
            - `caption` string
            - `height` integer
            - `meta` object
            - `type` 'embed', required
            - `url` string, required
          - RichTextBlockHeadline
            - `content` RichTextInline[], required
              - …
            - `level` integer, required
            - `meta` object
            - `type` 'headline', required
          - RichTextBlockIndentation
            - `content` RichTextBlock[], required
            - `type` 'indentation', required
          - RichTextBlockList
            - `bulletListMarker` string
            - `items` RichTextListItem[], required
              - …
            - `meta` object
            - `ordered` boolean, required
            - `orderedListDelimiter` string
            - `orderedListStartsAt` integer
            - `type` 'list', required
          - RichTextBlockPanel
            - `colorHex` string
            - `content` RichTextBlock[], required
            - `title` string
            - `type` 'panel', required
          - RichTextBlockParagraph
            - `content` RichTextInline[], required
              - …
            - `meta` object
            - `type` 'paragraph', required
    - `fields` object, required
    - `id` string, uuid, required
    - `name` string, required
    - `order` integer, required
    - `statusId` string, uuid, required
    - `workspaceId` string, uuid, required
  - `links` TemplateInstructionsCreateLink[]
    - `conditions` TemplateInstructionsInstructionCondition[]
      - union
        - TemplateInstructionsInstructionConditionMustHaveFeature
          - `feature` string, required
          - `type` 'mustHaveFeature', required
        - TemplateInstructionsInstructionConditionMustNotHaveFeature
          - `feature` string, required
          - `type` 'mustNotHaveFeature', required
    - `fromItemId` string, uuid, required
    - `fromOrder` integer, required
    - `id` string, uuid, required
    - `linkTypeId` string, uuid, required
    - `toItemId` string, uuid, required
    - `toOrder` integer, required
  - `statuses` TemplateInstructionsCreateStatus[]
    - `category` 'active' | 'closed' | 'draft', required: Status category adds some additional meaning to each status: - 'draft': only semantic meaning - 'active': only semantic meaning - 'closed': items with a status in this category will be considered as completed, which contributes to progress calculation (e.g. "1/3 items completed").
    - `color` 'blue' | 'coco' | 'daulphine' | 'great' | 'orange' | 'pink' | 'red' | 'violet' | 'yellow': Color of a status-chip in UI.
    - `conditions` TemplateInstructionsInstructionCondition[]
      - union
        - TemplateInstructionsInstructionConditionMustHaveFeature
          - `feature` string, required
          - `type` 'mustHaveFeature', required
        - TemplateInstructionsInstructionConditionMustNotHaveFeature
          - `feature` string, required
          - `type` 'mustNotHaveFeature', required
    - `default` boolean, required
    - `id` string, uuid, required
    - `name` string, required
    - `order` integer, required
    - `value` number, required
    - `workspaceId` string, uuid, required
  - `views` TemplateInstructionsInstallView[]
    - `conditions` TemplateInstructionsInstructionCondition[]
      - union
        - TemplateInstructionsInstructionConditionMustHaveFeature
          - `feature` string, required
          - `type` 'mustHaveFeature', required
        - TemplateInstructionsInstructionConditionMustNotHaveFeature
          - `feature` string, required
          - `type` 'mustNotHaveFeature', required
    - `description` string, required
    - `id` string, uuid, required
    - `itemFilter` union
      - ItemSearchQueryFilterAliasContain
        - `caseSensitive` boolean, required
        - `text` string, required
        - `type` 'alias:contain', required
      - ItemSearchQueryFilterAnd
        - `inner` ItemSearchQueryFilter[], required
        - `type` 'and', required
      - ItemSearchQueryFilterArchivedValue
        - `type` 'archived:value', required
        - `value` boolean, required
      - ItemSearchQueryFilterAssigneesContain
        - `type` 'assignees:contain', required
        - `user` union, required
          - UserRefUserGroupRefId
            - `id` string, uuid, required
            - `type` 'groupId', required
          - UserRefUserRefCurrent
            - `type` 'current', required
          - UserRefUserRefId
            - `id` string, uuid, required
            - `type` 'id', required
      - ItemSearchQueryFilterAssigneesContainsAll
        - `type` 'assignees:containsAll', required
        - `users` UserRef[], required
          - union
            - UserRefUserGroupRefId
              - …
            - UserRefUserRefCurrent
              - …
            - UserRefUserRefId
              - …
      - ItemSearchQueryFilterAssigneesContainsAny
        - `type` 'assignees:containsAny', required
        - `users` UserRef[], required
          - union
            - UserRefUserGroupRefId
              - …
            - UserRefUserRefCurrent
              - …
            - UserRefUserRefId
              - …
      - ItemSearchQueryFilterAssigneesDefined
        - `type` 'assignees:defined', required
      - ItemSearchQueryFilterCompletionTimeBetween
        - `end` integer, required: end range in days
        - `start` integer, required: start range in days
        - `type` 'completionTime:between', required
      - ItemSearchQueryFilterCreatedAtAbsolute
        - `mode` 'after' | 'afterOrOn' | 'before' | 'beforeOrOn', required
        - `type` 'createdAt:absolute', required
        - `value` ItemSearchQueryDateTimeFilterValue, required
          - `date` string, date, required
          - `time` string
          - `zoneId` string, required
      - ItemSearchQueryFilterCreatedAtRange
        - `from` string, date, required
        - `type` 'createdAt:range', required
        - `until` string, date, required
      - ItemSearchQueryFilterCreatedAtRelative
        - `anchor` union, required
          - ItemSearchQueryTimeAnchorDays
            - `count` integer, required
            - `type` 'days', required
          - ItemSearchQueryTimeAnchorMonths
            - `count` integer, required
            - `type` 'months', required
          - ItemSearchQueryTimeAnchorWeeks
            - `count` integer, required
            - `type` 'weeks', required
        - `type` 'createdAt:relative', required
      - ItemSearchQueryFilterDescriptionContain
        - `caseSensitive` boolean, required
        - `text` string, required
        - `type` 'description:contain', required
      - ItemSearchQueryFilterDescriptionDefined
        - `type` 'description:defined', required
      - ItemSearchQueryFilterFieldType
        - `fieldType` string, required
        - `filter` union, required
          - union
            - BooleanFieldTypeFilterDefined
              - …
            - BooleanFieldTypeFilterEqual
              - …
          - union
            - DateFieldTypeFilterAfter
              - …
            - DateFieldTypeFilterAfterOrOn
              - …
            - DateFieldTypeFilterBefore
              - …
            - DateFieldTypeFilterBeforeOrOn
              - …
            - DateFieldTypeFilterDefined
              - …
            - DateFieldTypeFilterRange
              - …
            - DateFieldTypeFilterRelative
              - …
          - union
            - DateRangeFieldTypeFilterDefined
              - …
            - DateRangeFieldTypeFilterEndBefore
              - …
            - DateRangeFieldTypeFilterEndBeforeOrOn
              - …
            - DateRangeFieldTypeFilterStartAfter
              - …
            - DateRangeFieldTypeFilterStartAfterOrOn
              - …
          - union
            - FormSourceFieldTypeFilterContain
              - …
            - FormSourceFieldTypeFilterDefined
              - …
          - FormsTargetFieldTypeFilter
            - `type` 'defined', required
          - union
            - HealthCheckInsConfidenceFieldFilterContainsAny
              - …
            - HealthCheckInsConfidenceFieldFilterDefined
              - …
          - union
            - InsightsFieldTypeFilterContain
              - …
            - InsightsFieldTypeFilterDefined
              - …
            - InsightsFieldTypeFilterEqual
              - …
            - InsightsFieldTypeFilterGreaterThan
              - …
            - InsightsFieldTypeFilterGreaterThanOrEqual
              - …
            - InsightsFieldTypeFilterLessThan
              - …
            - InsightsFieldTypeFilterLessThanOrEqual
              - …
          - union
            - MilestoneFieldFilterAfter
              - …
            - MilestoneFieldFilterAfterOrOn
              - …
            - MilestoneFieldFilterBefore
              - …
            - MilestoneFieldFilterBeforeOrOn
              - …
            - MilestoneFieldFilterContainsAll
              - …
            - MilestoneFieldFilterContainsAny
              - …
            - MilestoneFieldFilterDefined
              - …
            - MilestoneFieldFilterRange
              - …
            - MilestoneFieldFilterRelative
              - …
          - MirrorSourceFieldTypeFilter
            - `type` 'defined', required
          - MirrorTargetFieldTypeFilter
            - `type` 'defined', required
          - union
            - NumberFieldTypeLikeFilterDefined
              - …
            - NumberFieldTypeLikeFilterEqual
              - …
            - NumberFieldTypeLikeFilterGreaterThan
              - …
            - NumberFieldTypeLikeFilterGreaterThanOrEqual
              - …
            - NumberFieldTypeLikeFilterLessThan
              - …
            - NumberFieldTypeLikeFilterLessThanOrEqual
              - …
          - union
            - OkrConfidenceFieldFilterContainsAny
              - …
            - OkrConfidenceFieldFilterDefined
              - …
          - union
            - OkrKeyResultReferenceFieldFilterContainsAnyKeyResult
              - …
            - OkrKeyResultReferenceFieldFilterContainsAnyObjective
              - …
            - OkrKeyResultReferenceFieldFilterDefined
              - …
          - OkrKeyResultsFieldFilter
            - `type` 'defined', required
          - union
            - PeopleFieldTypeFilterContain
              - …
            - PeopleFieldTypeFilterContainsAll
              - …
            - PeopleFieldTypeFilterContainsAny
              - …
            - PeopleFieldTypeFilterDefined
              - …
          - union
            - PortalFieldTypeFilterDefined
              - …
            - PortalFieldTypeFilterPublic
              - …
          - PortfolioSourceFieldFilter
            - `type` 'defined', required
          - union
            - RichTextFieldTypeFilterContain
              - …
            - RichTextFieldTypeFilterDefined
              - …
          - union
            - SelectFieldTypeFilterContain
              - …
            - SelectFieldTypeFilterContainsAll
              - …
            - SelectFieldTypeFilterContainsAny
              - …
            - SelectFieldTypeFilterDefined
              - …
          - union
            - TextFieldTypeFilterContain
              - …
            - TextFieldTypeFilterDefined
              - …
            - TextFieldTypeFilterEqual
              - …
          - union
            - TimePeriodFieldFilterContainsAll
              - …
            - TimePeriodFieldFilterContainsAny
              - …
            - TimePeriodFieldFilterDefined
              - …
            - TimePeriodFieldFilterEndBefore
              - …
            - TimePeriodFieldFilterEndBeforeOrOn
              - …
            - TimePeriodFieldFilterEndsBeforeEndOf
              - …
            - TimePeriodFieldFilterEndsBeforeStartOf
              - …
            - TimePeriodFieldFilterStartAfter
              - …
            - TimePeriodFieldFilterStartAfterOrOn
              - …
            - TimePeriodFieldFilterStartsAfterEndOf
              - …
            - TimePeriodFieldFilterStartsFromStartOf
              - …
          - union
            - VotingAppVotesFieldTypeFilterContainsAllUsers
              - …
            - VotingAppVotesFieldTypeFilterContainsAnyUsers
              - …
            - VotingAppVotesFieldTypeFilterDefined
              - …
        - `type` 'field:type', required
      - ItemSearchQueryFilterFieldValue
        - `fieldId` string, uuid, required
        - `filter` union, required
          - union
            - BooleanFieldTypeFilterDefined
              - …
            - BooleanFieldTypeFilterEqual
              - …
          - union
            - DateFieldTypeFilterAfter
              - …
            - DateFieldTypeFilterAfterOrOn
              - …
            - DateFieldTypeFilterBefore
              - …
            - DateFieldTypeFilterBeforeOrOn
              - …
            - DateFieldTypeFilterDefined
              - …
            - DateFieldTypeFilterRange
              - …
            - DateFieldTypeFilterRelative
              - …
          - union
            - DateRangeFieldTypeFilterDefined
              - …
            - DateRangeFieldTypeFilterEndBefore
              - …
            - DateRangeFieldTypeFilterEndBeforeOrOn
              - …
            - DateRangeFieldTypeFilterStartAfter
              - …
            - DateRangeFieldTypeFilterStartAfterOrOn
              - …
          - union
            - FormSourceFieldTypeFilterContain
              - …
            - FormSourceFieldTypeFilterDefined
              - …
          - FormsTargetFieldTypeFilter
            - `type` 'defined', required
          - union
            - HealthCheckInsConfidenceFieldFilterContainsAny
              - …
            - HealthCheckInsConfidenceFieldFilterDefined
              - …
          - union
            - InsightsFieldTypeFilterContain
              - …
            - InsightsFieldTypeFilterDefined
              - …
            - InsightsFieldTypeFilterEqual
              - …
            - InsightsFieldTypeFilterGreaterThan
              - …
            - InsightsFieldTypeFilterGreaterThanOrEqual
              - …
            - InsightsFieldTypeFilterLessThan
              - …
            - InsightsFieldTypeFilterLessThanOrEqual
              - …
          - union
            - MilestoneFieldFilterAfter
              - …
            - MilestoneFieldFilterAfterOrOn
              - …
            - MilestoneFieldFilterBefore
              - …
            - MilestoneFieldFilterBeforeOrOn
              - …
            - MilestoneFieldFilterContainsAll
              - …
            - MilestoneFieldFilterContainsAny
              - …
            - MilestoneFieldFilterDefined
              - …
            - MilestoneFieldFilterRange
              - …
            - MilestoneFieldFilterRelative
              - …
          - MirrorSourceFieldTypeFilter
            - `type` 'defined', required
          - MirrorTargetFieldTypeFilter
            - `type` 'defined', required
          - union
            - NumberFieldTypeLikeFilterDefined
              - …
            - NumberFieldTypeLikeFilterEqual
              - …
            - NumberFieldTypeLikeFilterGreaterThan
              - …
            - NumberFieldTypeLikeFilterGreaterThanOrEqual
              - …
            - NumberFieldTypeLikeFilterLessThan
              - …
            - NumberFieldTypeLikeFilterLessThanOrEqual
              - …
          - union
            - OkrConfidenceFieldFilterContainsAny
              - …
            - OkrConfidenceFieldFilterDefined
              - …
          - union
            - OkrKeyResultReferenceFieldFilterContainsAnyKeyResult
              - …
            - OkrKeyResultReferenceFieldFilterContainsAnyObjective
              - …
            - OkrKeyResultReferenceFieldFilterDefined
              - …
          - OkrKeyResultsFieldFilter
            - `type` 'defined', required
          - union
            - PeopleFieldTypeFilterContain
              - …
            - PeopleFieldTypeFilterContainsAll
              - …
            - PeopleFieldTypeFilterContainsAny
              - …
            - PeopleFieldTypeFilterDefined
              - …
          - union
            - PortalFieldTypeFilterDefined
              - …
            - PortalFieldTypeFilterPublic
              - …
          - PortfolioSourceFieldFilter
            - `type` 'defined', required
          - union
            - RichTextFieldTypeFilterContain
              - …
            - RichTextFieldTypeFilterDefined
              - …
          - union
            - SelectFieldTypeFilterContain
              - …
            - SelectFieldTypeFilterContainsAll
              - …
            - SelectFieldTypeFilterContainsAny
              - …
            - SelectFieldTypeFilterDefined
              - …
          - union
            - TextFieldTypeFilterContain
              - …
            - TextFieldTypeFilterDefined
              - …
            - TextFieldTypeFilterEqual
              - …
          - union
            - TimePeriodFieldFilterContainsAll
              - …
            - TimePeriodFieldFilterContainsAny
              - …
            - TimePeriodFieldFilterDefined
              - …
            - TimePeriodFieldFilterEndBefore
              - …
            - TimePeriodFieldFilterEndBeforeOrOn
              - …
            - TimePeriodFieldFilterEndsBeforeEndOf
              - …
            - TimePeriodFieldFilterEndsBeforeStartOf
              - …
            - TimePeriodFieldFilterStartAfter
              - …
            - TimePeriodFieldFilterStartAfterOrOn
              - …
            - TimePeriodFieldFilterStartsAfterEndOf
              - …
            - TimePeriodFieldFilterStartsFromStartOf
              - …
          - union
            - VotingAppVotesFieldTypeFilterContainsAllUsers
              - …
            - VotingAppVotesFieldTypeFilterContainsAnyUsers
              - …
            - VotingAppVotesFieldTypeFilterDefined
              - …
        - `type` 'field:value', required
      - ItemSearchQueryFilterIdAny
        - `type` 'id:any', required
        - `values` string[], required
      - ItemSearchQueryFilterIntegrationDefined
        - `type` 'integration:defined', required
      - ItemSearchQueryFilterIntegrationValue
        - `integrationId` string, uuid, required
        - `type` 'integration:value', required
      - ItemSearchQueryFilterItemWatchSelf
        - `type` 'item:watchSelf', required
      - ItemSearchQueryFilterLastUpdatedAtAbsolute
        - `mode` 'after' | 'afterOrOn' | 'before' | 'beforeOrOn', required
        - `property` union
          - 'archived' | 'assignees' | 'color' | 'createdAt' | 'creator' | 'description' | 'id' | 'lastUpdatedAt' | 'name' | 'number' | 'order' | 'status' | 'statusCategoryUpdatedAt' | 'statusUpdatedAt' | 'workspace'
          - string: A combination of 'fieldid:' prefix and a UUID field-id.
        - `type` 'lastUpdatedAt:absolute', required
        - `value` ItemSearchQueryDateTimeFilterValue, required
          - `date` string, date, required
          - `time` string
          - `zoneId` string, required
      - ItemSearchQueryFilterLastUpdatedAtRange
        - `from` string, date, required
        - `property` union
          - 'archived' | 'assignees' | 'color' | 'createdAt' | 'creator' | 'description' | 'id' | 'lastUpdatedAt' | 'name' | 'number' | 'order' | 'status' | 'statusCategoryUpdatedAt' | 'statusUpdatedAt' | 'workspace'
          - string: A combination of 'fieldid:' prefix and a UUID field-id.
        - `type` 'lastUpdatedAt:range', required
        - `until` string, date, required
      - ItemSearchQueryFilterLastUpdatedAtRelative
        - `anchor` union, required
          - ItemSearchQueryTimeAnchorDays
            - `count` integer, required
            - `type` 'days', required
          - ItemSearchQueryTimeAnchorMonths
            - `count` integer, required
            - `type` 'months', required
          - ItemSearchQueryTimeAnchorWeeks
            - `count` integer, required
            - `type` 'weeks', required
        - `property` union
          - 'archived' | 'assignees' | 'color' | 'createdAt' | 'creator' | 'description' | 'id' | 'lastUpdatedAt' | 'name' | 'number' | 'order' | 'status' | 'statusCategoryUpdatedAt' | 'statusUpdatedAt' | 'workspace'
          - string: A combination of 'fieldid:' prefix and a UUID field-id.
        - `type` 'lastUpdatedAt:relative', required
      - ItemSearchQueryFilterNameContain
        - `caseSensitive` boolean, required
        - `text` string, required
        - `type` 'name:contain', required
      - ItemSearchQueryFilterNameEqual
        - `caseSensitive` boolean, required
        - `text` string, required
        - `type` 'name:equal', required
      - ItemSearchQueryFilterNot
        - `inner` ItemSearchQueryFilter, required (recursive)
        - `type` 'not', required
      - ItemSearchQueryFilterOr
        - `inner` ItemSearchQueryFilter[], required
        - `type` 'or', required
      - ItemSearchQueryFilterParentDefined
        - `type` 'parent:defined', required
      - ItemSearchQueryFilterParentValue
        - `itemId` string, uuid, required
        - `type` 'parent:value', required
        - `workspaceId` string, uuid, required
      - ItemSearchQueryFilterStatusCategoryContainsAny
        - `categories` StatusCategory[], required
        - `type` 'statusCategory:containsAny', required
      - ItemSearchQueryFilterStatusCategoryUpdatedBetween
        - `end` string, date, required
        - `start` string, date, required
        - `type` 'statusCategory:updatedBetween', required
      - ItemSearchQueryFilterStatusCategoryUpdatedSince
        - `type` 'statusCategory:updatedSince', required
        - `value` union, required
          - ItemSearchQueryTimeAnchorDays
            - `count` integer, required
            - `type` 'days', required
          - ItemSearchQueryTimeAnchorMonths
            - `count` integer, required
            - `type` 'months', required
          - ItemSearchQueryTimeAnchorWeeks
            - `count` integer, required
            - `type` 'weeks', required
      - ItemSearchQueryFilterStatusContainsAny
        - `statusIds` string[], required
        - `type` 'status:containsAny', required
      - ItemSearchQueryFilterStatusUpdatedSince
        - `type` 'status:updatedSince', required
        - `value` union, required
          - ItemSearchQueryTimeAnchorDays
            - `count` integer, required
            - `type` 'days', required
          - ItemSearchQueryTimeAnchorMonths
            - `count` integer, required
            - `type` 'months', required
          - ItemSearchQueryTimeAnchorWeeks
            - `count` integer, required
            - `type` 'weeks', required
      - ItemSearchQueryFilterUpdatedSince
        - `property` union
          - 'archived' | 'assignees' | 'color' | 'createdAt' | 'creator' | 'description' | 'id' | 'lastUpdatedAt' | 'name' | 'number' | 'order' | 'status' | 'statusCategoryUpdatedAt' | 'statusUpdatedAt' | 'workspace'
          - string: A combination of 'fieldid:' prefix and a UUID field-id.
        - `timestamp` string, date-time, required
        - `type` 'updated:since', required
      - ItemSearchQueryFilterWorkspaceContains
        - `id` string, uuid, required
        - `type` 'workspace:contains', required
      - ItemSearchQueryFilterWorkspaceContainsAny
        - `type` 'workspace:containsAny', required
        - `workspaceIds` string[], required
    - `itemScopeLimit` union
      - ItemScopeLimitActive
        - `closed` ItemScopeLimitTimeAnchorSetting, required
          - `enabled` boolean, required
          - `value` union, required
            - ItemSearchQueryTimeAnchorDays
              - …
            - ItemSearchQueryTimeAnchorMonths
              - …
            - ItemSearchQueryTimeAnchorWeeks
              - …
        - `type` 'active', required
        - `updated` ItemScopeLimitTimeAnchorSetting, required
          - `enabled` boolean, required
          - `value` union, required
            - ItemSearchQueryTimeAnchorDays
              - …
            - ItemSearchQueryTimeAnchorMonths
              - …
            - ItemSearchQueryTimeAnchorWeeks
              - …
      - ItemScopeLimitHistory
        - `closed` ItemScopeLimitTimeAnchorSetting, required
          - `enabled` boolean, required
          - `value` union, required
            - ItemSearchQueryTimeAnchorDays
              - …
            - ItemSearchQueryTimeAnchorMonths
              - …
            - ItemSearchQueryTimeAnchorWeeks
              - …
        - `type` 'history', required
      - ItemScopeLimitUnplanned
        - `created` ItemScopeLimitTimeAnchorSetting, required
          - `enabled` boolean, required
          - `value` union, required
            - ItemSearchQueryTimeAnchorDays
              - …
            - ItemSearchQueryTimeAnchorMonths
              - …
            - ItemSearchQueryTimeAnchorWeeks
              - …
        - `type` 'unplanned', required
    - `itemSort` ItemSearchQuerySort[]
      - union
        - ItemSearchQuerySortCreatedAt
          - `direction` 'asc' | 'desc', required
          - `type` 'createdAt', required
        - ItemSearchQuerySortField
          - `direction` 'asc' | 'desc', required
          - `fieldId` string, uuid, required
          - `type` 'field', required
        - ItemSearchQuerySortFieldType
          - `direction` 'asc' | 'desc', required
          - `fieldType` string, required
          - `type` 'fieldType', required
        - ItemSearchQuerySortLastUpdatedAt
          - `direction` 'asc' | 'desc', required
          - `type` 'lastUpdatedAt', required
        - ItemSearchQuerySortName
          - `direction` 'asc' | 'desc', required
          - `type` 'name', required
        - ItemSearchQuerySortOrder
          - `direction` 'asc' | 'desc', required
          - `type` 'order', required
        - ItemSearchQuerySortParent
          - `direction` 'asc' | 'desc', required
          - `type` 'parent', required
        - ItemSearchQuerySortStatus
          - `direction` 'asc' | 'desc', required
          - `type` 'status', required
    - `name` string, required
    - `order` integer, required
    - `pinnedToPosition` integer
    - `settings` unknown, required
    - `typeId` string, required
    - `workspaceId` string, uuid, required
  - `workspaceGroups` TemplateInstructionsCreateWorkspaceGroup[]
    - `conditions` TemplateInstructionsInstructionCondition[]
      - union
        - TemplateInstructionsInstructionConditionMustHaveFeature
          - `feature` string, required
          - `type` 'mustHaveFeature', required
        - TemplateInstructionsInstructionConditionMustNotHaveFeature
          - `feature` string, required
          - `type` 'mustNotHaveFeature', required
    - `id` string, uuid, required
    - `name` string, required
    - `parentId` string, uuid
  - `workspaceRelations` TemplateInstructionsCreateWorkspaceRelation[]
    - `childId` string, uuid, required
    - `conditions` TemplateInstructionsInstructionCondition[]
      - union
        - TemplateInstructionsInstructionConditionMustHaveFeature
          - `feature` string, required
          - `type` 'mustHaveFeature', required
        - TemplateInstructionsInstructionConditionMustNotHaveFeature
          - `feature` string, required
          - `type` 'mustNotHaveFeature', required
    - `id` string, uuid, required
    - `parentId` string, uuid, required
  - `workspaces` TemplateInstructionsCreateWorkspace[]
    - `archived` boolean, required
    - `conditions` TemplateInstructionsInstructionCondition[]
      - union
        - TemplateInstructionsInstructionConditionMustHaveFeature
          - `feature` string, required
          - `type` 'mustHaveFeature', required
        - TemplateInstructionsInstructionConditionMustNotHaveFeature
          - `feature` string, required
          - `type` 'mustNotHaveFeature', required
    - `id` string, 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'
    - `metadata` WorkspaceWorkspaceMetadata
      - `duplicated` boolean, required: Whether this workspace was duplicated from another workspace.
      - `templateId` string: Id of the template used to create this workspace.
      - `templateWorkspaceRef` string: Which specific workspace-instruction in the template was used to create this workspace.
      - `version` string: Version of the server at the moment when this workspace was created.
    - `name` string, required
    - `namespace` 'main' | 'app:okr' | 'app:portfolio', required
    - `orderedFieldIds` string[]
    - `parentGroupId` string, uuid
    - `progressMode` 'count' | 'none' | 'percentage', required
    - `statusPresetId` string, uuid

## Other responses

- `401`: If missing authentication token.
- `403`: If user does not have the required permission, or authenticated client does not have the required access scopes.

---

[API](https://skmtc.dev/airfocus/apis/airfocus-api.md) · [All operations](https://skmtc.dev/airfocus/apis/airfocus-api/llms.txt) · [OpenAPI document](https://skmtc.dev/airfocus/apis/airfocus-api/revisions/fc9ccaa2ec6d?raw)