--- title: "Retrieve or search partial items" method: POST path: "/api/workspaces/{workspaceId}/items/search/partial" tags: ["Items"] --- # Retrieve or search partial items `POST /api/workspaces/{workspaceId}/items/search/partial` ## Request - Base URL: `https://app.airfocus.com` - URL: `https://app.airfocus.com/api/workspaces/{workspaceId}/items/search/partial` - Auth: HTTP bearer Search and return all requested properties from items. Always returns only items which are accessible by the current user.
Requirements:
- auth-client scopes: "workspace:read"
- user permission: "read" or higher ## Path parameters - `workspaceId` string, uuid, required ## Query parameters - `actAsAdmin` boolean - `offset` integer - `limit` integer - `from` integer - `to` integer ## Request body - SearchPartialItemRequest - `properties` RefItemExtendedProperty[], required - union - 'archived' | 'assignees' | 'color' | 'createdAt' | 'creator' | 'description' | 'embed:alias' | 'embed:apps' | 'embed:attachmentCount' | 'embed:children' | 'embed:commentCount' | 'embed:constraints' | 'embed:integration' | 'embed:linkCount' | 'embed:parents' | 'embed:progress' | 'embed:watched' | 'embed:workspaceItemType' | 'id' | 'lastUpdatedAt' | 'name' | 'number' | 'order' | 'status' | 'statusCategoryUpdatedAt' | 'statusUpdatedAt' | 'workspace' - string: A combination of 'fieldid:' prefix and a UUID field-id. - string: A combination of 'fieldtype:' prefix and a field type id. - string: Either 'embed:children' when all item fields are required or a combination of 'embed:children:' prefix and an ItemProperty or fieldType - string: Either 'embed:parents' when all item fields are required or a combination of 'embed:parents:' prefix and an ItemProperty or fieldType - `query` ItemSearchQuery - `archived` boolean - `filter` 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 - `sort` 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 ## Response `200` - ItemPartialWithItemPartialEmbedPage - `items` ItemPartialWithItemPartialEmbed[], required - `_embedded` ItemPartialEmbed, required - `alias` string - `apps` object - `attachmentCount` integer - `children` RelativeItemInfoPartial[] - `alias` string - `childOrder` integer, required - `item` ItemPartial - `archived` boolean - `assigneeUserGroupIds` string[] - `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' - `createdAt` string, date-time - `creator` union - ActorAiActor - … - ActorApp - … - ActorIntegration - … - ActorShareLink - … - ActorSystem - … - ActorUser - … - `description` RichText - `blocks` RichTextBlock[], required - … - `fields` object - `id` string, uuid, required - `lastUpdatedAt` string, date-time - `name` string - `number` integer - `order` integer - `statusCategoryUpdatedAt` string, date-time - `statusId` string, uuid - `statusUpdatedAt` string, date-time - `workspaceId` string, uuid - `itemId` string, uuid, required - `itemType` 'bug' | 'epic' | 'experiment' | 'feature' | 'feedback' | 'idea' | 'initiative' | 'app:okr:objective' | 'opportunity' | 'product' | 'project' | 'story' | 'task' - `parentOrder` integer, required - `relationId` string, uuid, required - `workspaceId` string, uuid, required - `commentCount` integer - `constraints` ItemConstraint[] - union - ItemConstraintIntegrationPushForbidden - `extensionId` string, uuid, required - `type` 'integrationPushForbidden', required - ItemConstraintIntegrationToInternal - `extensionId` string, uuid, required - `property` union, required - … - `type` 'integrationToInternal', required - ItemConstraintPropertyReadOnly - `extensionId` string, uuid, required - `property` union, required - … - `type` 'propertyReadOnly', required - ItemConstraintUndeletable - `extensionId` string, uuid, required - `type` 'undeletable', required - `integration` ItemEmbedIntegration - `data` unknown, required - `id` string, uuid, required - `typeId` string, required - `linkCount` integer - `parents` RelativeItemInfoPartial[] - `alias` string - `childOrder` integer, required - `item` ItemPartial - `archived` boolean - `assigneeUserGroupIds` string[] - `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' - `createdAt` string, date-time - `creator` union - ActorAiActor - … - ActorApp - … - ActorIntegration - … - ActorShareLink - … - ActorSystem - … - ActorUser - … - `description` RichText - `blocks` RichTextBlock[], required - … - `fields` object - `id` string, uuid, required - `lastUpdatedAt` string, date-time - `name` string - `number` integer - `order` integer - `statusCategoryUpdatedAt` string, date-time - `statusId` string, uuid - `statusUpdatedAt` string, date-time - `workspaceId` string, uuid - `itemId` string, uuid, required - `itemType` 'bug' | 'epic' | 'experiment' | 'feature' | 'feedback' | 'idea' | 'initiative' | 'app:okr:objective' | 'opportunity' | 'product' | 'project' | 'story' | 'task' - `parentOrder` integer, required - `relationId` string, uuid, required - `workspaceId` string, uuid, required - `progress` ItemEmbedProgress - `closed` integer, required - `total` integer, required - `watched` boolean - `workspaceItemType` 'bug' | 'epic' | 'experiment' | 'feature' | 'feedback' | 'idea' | 'initiative' | 'app:okr:objective' | 'opportunity' | 'product' | 'project' | 'story' | 'task' - `archived` boolean - `assigneeUserGroupIds` string[] - `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' - `createdAt` string, date-time - `creator` union - ActorAiActor - `actorType` union - 'assistant' | 'mcpServer' - string: An 'agent:' prefix followed by the specific agent type, e.g., 'agent:default:insights:create' - `id` string, uuid, required - `onBehalfOf` Actor, required (recursive) - `type` 'aiActor', required - ActorApp - `id` string, uuid, required - `onBehalfOf` Actor (recursive) - `type` 'app', required - `typeId` string - ActorIntegration - `id` string, uuid, required - `onBehalfOf` Actor (recursive) - `type` 'integration', required - `typeId` string - ActorShareLink - `type` 'shareLink', required - ActorSystem - `type` 'system', required - ActorUser - `id` string, uuid, required - `type` 'user', required - `description` RichText - `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 - `id` string, uuid, required - `lastUpdatedAt` string, date-time - `name` string - `number` integer - `order` integer - `statusCategoryUpdatedAt` string, date-time - `statusId` string, uuid - `statusUpdatedAt` string, date-time - `workspaceId` string, uuid - `totalItems` integer, required ## Other responses - `400`: If payload is invalid. - `401`: If missing authentication token. - `403`: If user does not have the required permission, or authenticated client does not have the required access scopes. - `default`: If any other error happens. --- [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)