{
"components": {
"schemas": {
"Actor": {
"discriminator": {
"mapping": {
"aiActor": "#/components/schemas/ActorAiActor",
"app": "#/components/schemas/ActorApp",
"integration": "#/components/schemas/ActorIntegration",
"user": "#/components/schemas/ActorUser"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ActorAiActor"
},
{
"$ref": "#/components/schemas/ActorApp"
},
{
"$ref": "#/components/schemas/ActorIntegration"
},
{
"$ref": "#/components/schemas/ActorUser"
}
],
"title": "Actor"
},
"ActorAiActor": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"onBehalfOf": {
"$ref": "#/components/schemas/Actor"
},
"type": {
"const": "aiActor",
"type": "string"
}
},
"required": [
"id",
"onBehalfOf",
"type"
],
"title": "ActorAiActor",
"type": "object"
},
"ActorApp": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"onBehalfOf": {
"$ref": "#/components/schemas/Actor"
},
"type": {
"const": "app",
"type": "string"
},
"typeId": {
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "ActorApp",
"type": "object"
},
"ActorIntegration": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"onBehalfOf": {
"$ref": "#/components/schemas/Actor"
},
"type": {
"const": "integration",
"type": "string"
},
"typeId": {
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "ActorIntegration",
"type": "object"
},
"ActorUser": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "user",
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "ActorUser",
"type": "object"
},
"AiActor": {
"properties": {
"actorType": {
"$ref": "#/components/schemas/AiActorType"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"singletonKey": {
"type": "string"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"type": "string"
}
},
"required": [
"id",
"teamId",
"name",
"actorType",
"createdAt",
"updatedAt"
],
"title": "AiActor",
"type": "object"
},
"AiActorType": {
"oneOf": [
{
"enum": [
"assistant",
"mcpServer"
],
"type": "string"
},
{
"description": "An 'agent:' prefix followed by the specific agent type, e.g., 'agent:default:insights:create'",
"pattern": "^agent:[a-zA-Z0-9_:-]+$",
"type": "string"
}
],
"title": "AiActorType"
},
"AiFieldSettings": {
"properties": {
"prompt": {
"type": "string"
},
"shouldAutofill": {
"type": "boolean"
}
},
"required": [
"shouldAutofill"
],
"title": "AiFieldSettings",
"type": "object"
},
"AiSummaryWidget": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"dataSettings": {
"$ref": "#/components/schemas/AiSummaryWidgetDataSettings"
},
"generatedAt": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"itemCount": {
"format": "int32",
"type": "integer"
},
"summary": {
"$ref": "#/components/schemas/RichText",
"description": "Rich text content as structured blocks. Different media types provide markdown support:\n• application/json - Default blocks format\n• application/vnd.airfocus.markdown+json - All RichText fields become markdown strings (recommended)\n• application/json+markdown - Legacy format, only top-level fields converted to markdown"
},
"title": {
"type": "string"
},
"type": {
"const": "aiSummary",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"type": "string"
}
},
"required": [
"id",
"title",
"summary",
"createdAt",
"updatedAt",
"dataSettings",
"type"
],
"title": "AiSummaryWidget",
"type": "object"
},
"AiSummaryWidgetDataSettings": {
"properties": {
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"period": {
"$ref": "#/components/schemas/WidgetPeriod"
},
"prompt": {
"type": "string"
}
},
"title": "AiSummaryWidgetDataSettings",
"type": "object"
},
"ApiKey": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"lastUsedAt": {
"format": "date-time",
"type": "string"
},
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"userId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"userId",
"scopes",
"name",
"createdAt"
],
"title": "ApiKey",
"type": "object"
},
"App": {
"discriminator": {
"mapping": {
"capacity-planning": "#/components/schemas/CapacityPlanningApp",
"forms": "#/components/schemas/FormsApp",
"health-check-ins": "#/components/schemas/HealthCheckInsApp",
"insights": "#/components/schemas/InsightsApp",
"mirror": "#/components/schemas/MirrorApp",
"okr": "#/components/schemas/OkrApp",
"portal": "#/components/schemas/PortalApp",
"portfolio": "#/components/schemas/PortfolioApp",
"prioritization": "#/components/schemas/PrioritizationApp",
"voting": "#/components/schemas/VotingApp"
},
"propertyName": "typeId"
},
"oneOf": [
{
"$ref": "#/components/schemas/CapacityPlanningApp"
},
{
"$ref": "#/components/schemas/FormsApp"
},
{
"$ref": "#/components/schemas/HealthCheckInsApp"
},
{
"$ref": "#/components/schemas/InsightsApp"
},
{
"$ref": "#/components/schemas/MirrorApp"
},
{
"$ref": "#/components/schemas/OkrApp"
},
{
"$ref": "#/components/schemas/PortalApp"
},
{
"$ref": "#/components/schemas/PortfolioApp"
},
{
"$ref": "#/components/schemas/PrioritizationApp"
},
{
"$ref": "#/components/schemas/VotingApp"
}
],
"title": "App"
},
"ApplyTemplateRequest": {
"properties": {
"defaultPermission": {
"$ref": "#/components/schemas/Permission"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"$ref": "#/components/schemas/TemplateParameters"
},
"permissions": {
"additionalProperties": {
"$ref": "#/components/schemas/Permission"
},
"type": "object"
},
"userGroupPermissions": {
"additionalProperties": {
"$ref": "#/components/schemas/Permission"
},
"type": "object"
}
},
"required": [
"parameters",
"permissions",
"userGroupPermissions"
],
"title": "ApplyTemplateRequest",
"type": "object"
},
"AsanaIntegrationSummary": {
"properties": {
"capabilities": {
"$ref": "#/components/schemas/IntegrationCapabilities"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"lastSyncAt": {
"format": "date-time",
"type": "string"
},
"lastSyncState": {
"$ref": "#/components/schemas/IntegrationSyncState"
},
"settings": {
"$ref": "#/components/schemas/AsanaIntegrationTypeSettings"
},
"typeId": {
"const": "asana",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"createdAt",
"capabilities",
"enabled"
],
"title": "AsanaIntegrationSummary",
"type": "object"
},
"AsanaIntegrationTypeSettings": {
"properties": {
"autoSync": {
"type": "boolean"
},
"mappings": {
"default": [],
"items": {
"$ref": "#/components/schemas/MappingSettingsIntegrationMappingSettings"
},
"type": "array"
},
"removeExtraneous": {
"type": "boolean"
},
"secrets": {
"$ref": "#/components/schemas/IntegrationSecrets"
},
"selectProject": {
"type": "string"
},
"selectTags": {
"items": {
"type": "string"
},
"type": "array"
},
"selectWorkspace": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"removeExtraneous",
"autoSync"
],
"title": "AsanaIntegrationTypeSettings",
"type": "object"
},
"AttachmentSearchQuery": {
"properties": {
"itemId": {
"format": "uuid",
"type": "string"
}
},
"title": "AttachmentSearchQuery",
"type": "object"
},
"AuthorFormatLevel": {
"enum": [
"email",
"name",
"type"
],
"title": "AuthorFormatLevel",
"type": "string"
},
"AzureDevopsIntegrationSummary": {
"properties": {
"capabilities": {
"$ref": "#/components/schemas/IntegrationCapabilities"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"lastSyncAt": {
"format": "date-time",
"type": "string"
},
"lastSyncState": {
"$ref": "#/components/schemas/IntegrationSyncState"
},
"settings": {
"$ref": "#/components/schemas/AzureDevopsIntegrationTypeSettings"
},
"typeId": {
"const": "azure-devops",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"createdAt",
"capabilities",
"enabled"
],
"title": "AzureDevopsIntegrationSummary",
"type": "object"
},
"AzureDevopsIntegrationTypeSettings": {
"properties": {
"addLabel": {
"type": "string"
},
"autoSync": {
"type": "boolean"
},
"baseUrl": {
"type": "string"
},
"connectRelatives": {
"type": "boolean"
},
"includeSubAreas": {
"type": "boolean"
},
"mappings": {
"default": [],
"items": {
"$ref": "#/components/schemas/MappingSettingsIntegrationMappingSettings"
},
"type": "array"
},
"onPremiseSecrets": {
"$ref": "#/components/schemas/AzureDevopsIntegrationTypeSettingsAzureDevopsOnPremiseSecrets"
},
"removeExtraneous": {
"type": "boolean"
},
"search": {
"type": "string"
},
"secrets": {
"$ref": "#/components/schemas/AzureDevopsIntegrationTypeSettingsAzureDevopsSettingsSecrets"
},
"selectAccount": {
"type": "string"
},
"selectArea": {
"format": "int32",
"type": "integer"
},
"selectProject": {
"type": "string"
},
"showDescription": {
"type": "boolean"
},
"tenantId": {
"type": "string"
},
"title": {
"type": "string"
},
"twoWay": {
"type": "boolean"
}
},
"required": [
"includeSubAreas",
"showDescription",
"removeExtraneous",
"twoWay",
"autoSync",
"connectRelatives"
],
"title": "AzureDevopsIntegrationTypeSettings",
"type": "object"
},
"AzureDevopsIntegrationTypeSettingsAzureDevopsOnPremiseSecrets": {
"properties": {
"accountName": {
"type": "string"
},
"personalAccessToken": {
"type": "string"
}
},
"required": [
"personalAccessToken",
"accountName"
],
"title": "AzureDevopsIntegrationTypeSettingsAzureDevopsOnPremiseSecrets",
"type": "object"
},
"AzureDevopsIntegrationTypeSettingsAzureDevopsSettingsSecrets": {
"properties": {
"accessToken": {
"type": "string"
},
"expiration": {
"format": "date-time",
"type": "string"
},
"refreshToken": {
"type": "string"
},
"tokenType": {
"type": "string"
}
},
"required": [
"accessToken",
"expiration",
"refreshToken"
],
"title": "AzureDevopsIntegrationTypeSettingsAzureDevopsSettingsSecrets",
"type": "object"
},
"BoardViewTypeSettings": {
"properties": {
"colorMode": {
"$ref": "#/components/schemas/ColorMode"
},
"groupBy": {
"default": [],
"items": {
"$ref": "#/components/schemas/GroupBy"
},
"type": "array"
},
"laneField": {
"$ref": "#/components/schemas/ViewSettingsField"
},
"showAlias": {
"default": false,
"type": "boolean"
},
"showAssignees": {
"default": false,
"type": "boolean"
},
"showChildItems": {
"default": true,
"type": "boolean"
},
"showCreatedAt": {
"default": false,
"type": "boolean"
},
"showFieldIds": {
"default": [],
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"showFieldTypes": {
"default": [],
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"showIntegrations": {
"default": false,
"type": "boolean"
},
"showLastUpdatedAt": {
"default": false,
"type": "boolean"
},
"showParentItems": {
"default": false,
"type": "boolean"
},
"showProgress": {
"default": true,
"type": "boolean"
},
"showStatus": {
"default": true,
"type": "boolean"
}
},
"required": [
"laneField"
],
"title": "BoardViewTypeSettings",
"type": "object"
},
"BoardViewWithViewEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/ViewEmbed"
},
"description": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isPrivate": {
"type": "boolean"
},
"itemFilter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"itemScopeLimit": {
"$ref": "#/components/schemas/ItemScopeLimit"
},
"itemSort": {
"items": {
"$ref": "#/components/schemas/ItemSearchQuerySort"
},
"type": "array"
},
"name": {
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"pinnedToPosition": {
"format": "int32",
"type": "integer"
},
"settings": {
"$ref": "#/components/schemas/BoardViewTypeSettings"
},
"typeId": {
"const": "board",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"typeId",
"settings",
"name",
"description",
"itemSort",
"order",
"isPrivate",
"_embedded"
],
"title": "BoardViewWithViewEmbed",
"type": "object"
},
"BooleanField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "boolean",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "BooleanField",
"type": "object"
},
"BooleanFieldTypeFilter": {
"discriminator": {
"mapping": {
"defined": "#/components/schemas/BooleanFieldTypeFilterDefined",
"equal": "#/components/schemas/BooleanFieldTypeFilterEqual"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/BooleanFieldTypeFilterDefined"
},
{
"$ref": "#/components/schemas/BooleanFieldTypeFilterEqual"
}
],
"title": "BooleanFieldTypeFilter"
},
"BooleanFieldTypeFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "BooleanFieldTypeFilterDefined",
"type": "object"
},
"BooleanFieldTypeFilterEqual": {
"properties": {
"boolean": {
"type": "boolean"
},
"type": {
"const": "equal",
"type": "string"
}
},
"required": [
"boolean",
"type"
],
"title": "BooleanFieldTypeFilterEqual",
"type": "object"
},
"BooleanFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "boolean",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "BooleanFieldWithFieldEmbed",
"type": "object"
},
"BulkInviteUsersRequest": {
"properties": {
"users": {
"items": {
"$ref": "#/components/schemas/BulkInviteUsersRequestUser"
},
"type": "array"
}
},
"required": [
"users"
],
"title": "BulkInviteUsersRequest",
"type": "object"
},
"BulkInviteUsersRequestUser": {
"properties": {
"email": {
"type": "string"
},
"fullName": {
"type": "string"
},
"role": {
"$ref": "#/components/schemas/Role"
}
},
"required": [
"email",
"role"
],
"title": "BulkInviteUsersRequestUser",
"type": "object"
},
"CapacityPlanningApp": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/CapacityPlanningAppSettings"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "capacity-planning",
"type": "string"
}
},
"required": [
"id",
"teamId",
"typeId",
"settings"
],
"title": "CapacityPlanningApp",
"type": "object"
},
"CapacityPlanningAppSettings": {
"properties": {
"bucketType": {
"$ref": "#/components/schemas/CapacityPlanningBucketType"
},
"capacityFieldId": {
"description": "Field which represents the capacity value (money, people, story-points, etc). It must be a number-like field.",
"format": "uuid",
"type": "string"
},
"resourceType": {
"$ref": "#/components/schemas/CapacityPlanningResourceType"
},
"segmentFieldId": {
"description": "Field which represents a partition over which the capacity will be grouped (money, people, story-points, etc). It must be an enum-like field.",
"format": "uuid",
"type": "string"
},
"workspaceIds": {
"description": "All workspaces in which this app provides its service",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"workspaceIds",
"capacityFieldId",
"segmentFieldId",
"resourceType",
"bucketType"
],
"title": "CapacityPlanningAppSettings",
"type": "object"
},
"CapacityPlanningBucketType": {
"discriminator": {
"mapping": {
"capacity": "#/components/schemas/CapacityPlanningBucketTypeCapacity"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/CapacityPlanningBucketTypeCapacity"
}
],
"title": "CapacityPlanningBucketType"
},
"CapacityPlanningBucketTypeCapacity": {
"properties": {
"type": {
"const": "capacity",
"type": "string"
}
},
"required": [
"type"
],
"title": "CapacityPlanningBucketTypeCapacity",
"type": "object"
},
"CapacityPlanningResourceType": {
"description": "Configuration of available capacity for each segment/partition",
"discriminator": {
"mapping": {
"manual": "#/components/schemas/CapacityPlanningResourceTypeManual"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/CapacityPlanningResourceTypeManual"
}
],
"title": "CapacityPlanningResourceType"
},
"CapacityPlanningResourceTypeManual": {
"properties": {
"capacities": {
"items": {
"$ref": "#/components/schemas/CapacityPlanningResourceTypePartitionCapacity"
},
"type": "array"
},
"defaultCapacity": {
"type": "number"
},
"type": {
"const": "manual",
"type": "string"
}
},
"required": [
"capacities",
"type"
],
"title": "CapacityPlanningResourceTypeManual",
"type": "object"
},
"CapacityPlanningResourceTypePartitionCapacity": {
"properties": {
"capacity": {
"type": "number"
},
"partitionId": {
"type": "string"
}
},
"required": [
"partitionId",
"capacity"
],
"title": "CapacityPlanningResourceTypePartitionCapacity",
"type": "object"
},
"CapacityPlanningWidget": {
"properties": {
"dataSettings": {
"$ref": "#/components/schemas/CapacityPlanningWidgetDataSettings"
},
"id": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"const": "capacityPlanning",
"type": "string"
}
},
"required": [
"id",
"title",
"dataSettings",
"type"
],
"title": "CapacityPlanningWidget",
"type": "object"
},
"CapacityPlanningWidgetDataSettings": {
"properties": {
"resourceId": {
"description": "Capacity app id",
"format": "uuid",
"type": "string"
},
"segmentId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"segmentId",
"resourceId"
],
"title": "CapacityPlanningWidgetDataSettings",
"type": "object"
},
"ChangePasswordRequest": {
"properties": {
"newPassword": {
"type": "string"
},
"oldPassword": {
"type": "string"
}
},
"required": [
"oldPassword",
"newPassword"
],
"title": "ChangePasswordRequest",
"type": "object"
},
"ChangeUserDisabledRequest": {
"properties": {
"disabled": {
"type": "boolean"
},
"userId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"userId",
"disabled"
],
"title": "ChangeUserDisabledRequest",
"type": "object"
},
"ChangeUserRoleRequest": {
"properties": {
"role": {
"$ref": "#/components/schemas/Role"
},
"userId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"userId",
"role"
],
"title": "ChangeUserRoleRequest",
"type": "object"
},
"ChartViewTypeSettings": {
"properties": {
"colorMode": {
"$ref": "#/components/schemas/ColorMode",
"default": {
"type": "itemColor"
}
},
"cornerLabels": {
"$ref": "#/components/schemas/ChartViewTypeSettingsCornerLabels"
},
"showAlias": {
"default": false,
"type": "boolean"
},
"showAssignees": {
"default": false,
"type": "boolean"
},
"showChildItems": {
"default": true,
"type": "boolean"
},
"showCreatedAt": {
"default": false,
"type": "boolean"
},
"showFieldIds": {
"default": [],
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"showFieldTypes": {
"default": [],
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"showIntegrations": {
"default": false,
"type": "boolean"
},
"showItemNames": {
"default": false,
"type": "boolean"
},
"showLastUpdatedAt": {
"default": false,
"type": "boolean"
},
"showParentItems": {
"default": false,
"type": "boolean"
},
"showProgress": {
"default": true,
"type": "boolean"
},
"showStatus": {
"default": true,
"type": "boolean"
}
},
"title": "ChartViewTypeSettings",
"type": "object"
},
"ChartViewTypeSettingsCornerLabels": {
"default": {
"bottomLeft": "",
"bottomRight": "",
"topLeft": "",
"topRight": ""
},
"properties": {
"bottomLeft": {
"default": "",
"type": "string"
},
"bottomRight": {
"default": "",
"type": "string"
},
"topLeft": {
"default": "",
"type": "string"
},
"topRight": {
"default": "",
"type": "string"
}
},
"title": "ChartViewTypeSettingsCornerLabels",
"type": "object"
},
"ChartViewWithViewEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/ViewEmbed"
},
"description": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isPrivate": {
"type": "boolean"
},
"itemFilter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"itemScopeLimit": {
"$ref": "#/components/schemas/ItemScopeLimit"
},
"itemSort": {
"items": {
"$ref": "#/components/schemas/ItemSearchQuerySort"
},
"type": "array"
},
"name": {
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"pinnedToPosition": {
"format": "int32",
"type": "integer"
},
"settings": {
"$ref": "#/components/schemas/ChartViewTypeSettings"
},
"typeId": {
"const": "chart",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"typeId",
"settings",
"name",
"description",
"itemSort",
"order",
"isPrivate",
"_embedded"
],
"title": "ChartViewWithViewEmbed",
"type": "object"
},
"ChartWidget": {
"properties": {
"dataSettings": {
"$ref": "#/components/schemas/ChartWidgetDataSettings"
},
"displaySettings": {
"$ref": "#/components/schemas/ChartWidgetDisplaySettings"
},
"id": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"const": "chart",
"type": "string"
}
},
"required": [
"id",
"title",
"dataSettings",
"displaySettings",
"type"
],
"title": "ChartWidget",
"type": "object"
},
"ChartWidgetDataSettings": {
"properties": {
"breakdown": {
"$ref": "#/components/schemas/ChartWidgetDataSettingsBreakdownSetting"
},
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"metric": {
"type": "string"
},
"period": {
"$ref": "#/components/schemas/WidgetPeriod"
},
"segment": {
"$ref": "#/components/schemas/ChartWidgetDataSettingsBreakdownSetting"
}
},
"required": [
"metric",
"breakdown"
],
"title": "ChartWidgetDataSettings",
"type": "object"
},
"ChartWidgetDataSettingsBreakdownId": {
"oneOf": [
{
"enum": [
"statusCategory",
"statusCompleted"
],
"type": "string"
},
{
"description": "Either fieldType:[Field] or property:[ItemProperty]",
"pattern": "^property:.*$",
"type": "string"
}
],
"title": "ChartWidgetDataSettingsBreakdownId"
},
"ChartWidgetDataSettingsBreakdownSetting": {
"properties": {
"bucketCount": {
"oneOf": [
{
"format": "int32",
"type": "integer"
},
{
"type": "string"
}
]
},
"groupingPeriod": {
"$ref": "#/components/schemas/ChartWidgetDataSettingsGroupingPeriod"
},
"id": {
"$ref": "#/components/schemas/ChartWidgetDataSettingsBreakdownId"
},
"interval": {
"format": "int32",
"type": "integer"
},
"showEmpty": {
"type": "boolean"
},
"sortBy": {
"$ref": "#/components/schemas/ChartWidgetDataSettingsSortBy"
}
},
"required": [
"id"
],
"title": "ChartWidgetDataSettingsBreakdownSetting",
"type": "object"
},
"ChartWidgetDataSettingsGroupingPeriod": {
"enum": [
"monthly",
"quarterly",
"weekly",
"yearly"
],
"title": "ChartWidgetDataSettingsGroupingPeriod",
"type": "string"
},
"ChartWidgetDataSettingsSortBy": {
"enum": [
"Count",
"Default"
],
"title": "ChartWidgetDataSettingsSortBy",
"type": "string"
},
"ChartWidgetDisplaySettings": {
"properties": {
"chartType": {
"$ref": "#/components/schemas/ChartWidgetDisplaySettingsChartType"
},
"showLegend": {
"type": "boolean"
},
"showPercentage": {
"type": "boolean"
},
"showTotal": {
"type": "boolean"
}
},
"required": [
"chartType",
"showLegend",
"showPercentage",
"showTotal"
],
"title": "ChartWidgetDisplaySettings",
"type": "object"
},
"ChartWidgetDisplaySettingsChartType": {
"enum": [
"BarChart",
"PieChart"
],
"title": "ChartWidgetDisplaySettingsChartType",
"type": "string"
},
"ClubhouseIntegrationSummary": {
"properties": {
"capabilities": {
"$ref": "#/components/schemas/IntegrationCapabilities"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"lastSyncAt": {
"format": "date-time",
"type": "string"
},
"lastSyncState": {
"$ref": "#/components/schemas/IntegrationSyncState"
},
"settings": {
"$ref": "#/components/schemas/ShortcutIntegrationTypeSettings"
},
"typeId": {
"const": "clubhouse",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"createdAt",
"capabilities",
"enabled"
],
"title": "ClubhouseIntegrationSummary",
"type": "object"
},
"ColorMode": {
"discriminator": {
"mapping": {
"byField": "#/components/schemas/ColorModeByField",
"byFieldType": "#/components/schemas/ColorModeByFieldType",
"byParent": "#/components/schemas/ColorModeByParent",
"byStatus": "#/components/schemas/ColorModeByStatus",
"itemColor": "#/components/schemas/ColorModeItemColor"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ColorModeByField"
},
{
"$ref": "#/components/schemas/ColorModeByFieldType"
},
{
"$ref": "#/components/schemas/ColorModeByParent"
},
{
"$ref": "#/components/schemas/ColorModeByStatus"
},
{
"$ref": "#/components/schemas/ColorModeItemColor"
}
],
"title": "ColorMode"
},
"ColorModeByField": {
"properties": {
"fieldId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "byField",
"type": "string"
}
},
"required": [
"fieldId",
"type"
],
"title": "ColorModeByField",
"type": "object"
},
"ColorModeByFieldType": {
"properties": {
"fieldTypeId": {
"type": "string"
},
"type": {
"const": "byFieldType",
"type": "string"
}
},
"required": [
"fieldTypeId",
"type"
],
"title": "ColorModeByFieldType",
"type": "object"
},
"ColorModeByParent": {
"properties": {
"type": {
"const": "byParent",
"type": "string"
}
},
"required": [
"type"
],
"title": "ColorModeByParent",
"type": "object"
},
"ColorModeByStatus": {
"properties": {
"type": {
"const": "byStatus",
"type": "string"
}
},
"required": [
"type"
],
"title": "ColorModeByStatus",
"type": "object"
},
"ColorModeItemColor": {
"properties": {
"type": {
"const": "itemColor",
"type": "string"
}
},
"required": [
"type"
],
"title": "ColorModeItemColor",
"type": "object"
},
"CommentBulkAction": {
"discriminator": {
"mapping": {
"create": "#/components/schemas/CommentBulkCreate",
"delete": "#/components/schemas/CommentBulkDelete",
"patch": "#/components/schemas/CommentBulkPatch",
"update": "#/components/schemas/CommentBulkUpdate"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/CommentBulkCreate"
},
{
"$ref": "#/components/schemas/CommentBulkDelete"
},
{
"$ref": "#/components/schemas/CommentBulkPatch"
},
{
"$ref": "#/components/schemas/CommentBulkUpdate"
}
],
"title": "CommentBulkAction"
},
"CommentBulkCreate": {
"properties": {
"resource": {
"$ref": "#/components/schemas/ItemCommentCreateRequest"
},
"type": {
"enum": [
"create"
],
"type": "string"
}
},
"required": [
"resource",
"type"
],
"title": "CommentBulkCreate",
"type": "object"
},
"CommentBulkDelete": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"type": {
"enum": [
"delete"
],
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "CommentBulkDelete",
"type": "object"
},
"CommentBulkPatch": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"transform": {
"$ref": "#/components/schemas/JsonPatch"
},
"type": {
"enum": [
"patch"
],
"type": "string"
}
},
"required": [
"id",
"transform",
"type"
],
"title": "CommentBulkPatch",
"type": "object"
},
"CommentBulkUpdate": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/ItemCommentUpdateRequest"
},
"type": {
"enum": [
"update"
],
"type": "string"
}
},
"required": [
"id",
"resource",
"type"
],
"title": "CommentBulkUpdate",
"type": "object"
},
"Confidence": {
"enum": [
"high",
"low",
"medium"
],
"title": "Confidence",
"type": "string"
},
"CreateApiKeyRequest": {
"properties": {
"name": {
"type": "string"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"scopes",
"name"
],
"title": "CreateApiKeyRequest",
"type": "object"
},
"CreateApiKeyResponse": {
"properties": {
"apiKey": {
"$ref": "#/components/schemas/ApiKey"
},
"secret": {
"type": "string"
}
},
"required": [
"apiKey",
"secret"
],
"title": "CreateApiKeyResponse",
"type": "object"
},
"CreateItemAttachmentRequest": {
"properties": {
"contentType": {
"description": "Type of updated content.",
"type": "string"
},
"itemId": {
"description": "ID of the item to which the attachment is linked.",
"format": "uuid",
"type": "string"
},
"name": {
"description": "Name of the attachment, e.g. its file name (to be displayed in UI).",
"type": "string"
},
"uri": {
"description": "URI of the attachment contents. It can be any URI, but conventionally it's a relative URI like 'attachment:1ecb9ecd-8a97-403a-a74a-741eb4b8fb69' with UUID of a file uploaded to airfocus file-storage. Such URI is then resolved by clients into a full HTTPS URL.",
"type": "string"
}
},
"required": [
"itemId",
"name",
"uri",
"contentType"
],
"title": "CreateItemAttachmentRequest",
"type": "object"
},
"CreateItemLinkRequest": {
"properties": {
"fromItemId": {
"format": "uuid",
"type": "string"
},
"fromOrder": {
"description": "How this item-link is ordered in the list of links of the \"fromItem\".",
"format": "int32",
"type": "integer"
},
"toItemId": {
"format": "uuid",
"type": "string"
},
"toOrder": {
"description": "How this item-link is ordered in the list of links of the \"toItem\".",
"format": "int32",
"type": "integer"
},
"typeId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"fromItemId",
"toItemId",
"typeId",
"fromOrder",
"toOrder"
],
"title": "CreateItemLinkRequest",
"type": "object"
},
"CreateItemLinkTypeRequest": {
"description": "Custom item link type that defines how items can be related in both directions",
"properties": {
"backwardsName": {
"description": "The name of the link type used in the backward direction (\"{to} {backwards_name} {from}\"), e.g., \"is blocked by\" in \"B-34 is blocked by A-12\". Must contain at least one letter or digit.",
"type": "string"
},
"name": {
"description": "The name of the link type used in the forward direction (\"{from} {name} {to}\"), e.g., \"blocks\" in \"A-12 blocks B-34\". Must contain at least one letter or digit.",
"type": "string"
}
},
"required": [
"name",
"backwardsName"
],
"title": "CreateItemLinkTypeRequest",
"type": "object"
},
"CreateItemRequest": {
"properties": {
"archived": {
"default": false,
"description": "Whether this item is archived.",
"type": "boolean"
},
"assigneeUserGroupIds": {
"default": [],
"description": "Ids of user groups that are assigned to this item.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"assigneeUserIds": {
"default": [],
"description": "Ids of users who are assigned to this item.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"color": {
"$ref": "#/components/schemas/ItemColor",
"description": "Color of this item. If omitted, the server uses the workspace's default color."
},
"description": {
"$ref": "#/components/schemas/RichText",
"default": {
"blocks": [],
"richText": true
},
"description": "Rich-text description of this item."
},
"fields": {
"additionalProperties": {},
"default": {},
"description": "Values of custom fields, where each key is a custom-field ID and each value is a JSON-formatted value of the corresponding field.",
"examples": [
{
"0fc3cfbc-27e9-3ea6-8a78-7de13dae3e3c": {
"number": 42
},
"34f05b62-dd43-3e1e-82bc-b0acabd0d004": {
"boolean": true
},
"5396681e-ea50-3d63-9ae3-c9f8ca17b7d8": {
"userGroupIds": [
"70e2b87a-b774-3022-9ef0-e55031a1c4fb"
],
"userIds": [
"24c9e15e-52af-347c-a25b-757e7bee1f9d"
]
},
"75fe57ec-4a04-3a30-8cac-5f27223df81a": {
"dateRange": {
"endDate": "2024-02-14",
"startDate": "2024-01-14",
"timezone": "UTC"
}
},
"8be74552-df93-331b-bdd6-b36ed74bdb6a": {
"selection": [
"2bb225ce-b5ee-3493-967c-fde0d72da242"
]
},
"c7824f3d-4d5f-3b2f-a2d0-34758c1e9454": {
"text": "A platform built for the new way of doing product management"
},
"e34d514f-7db5-38aa-872a-7c8191a09617": {
"date": {
"date": "2024-01-01",
"timezone": "UTC"
}
}
}
],
"type": "object"
},
"name": {
"description": "Name (title) of this item.",
"type": "string"
},
"order": {
"description": "Order number of this item for sorting. If omitted, the item is appended at the end.",
"format": "int32",
"type": "integer"
},
"statusId": {
"description": "Id of the status of this item. If omitted, the server picks a default for the workspace.",
"format": "uuid",
"type": "string"
}
},
"required": [
"name"
],
"title": "CreateItemRequest",
"type": "object"
},
"CreateItemRequestWithMD": {
"description": "Item with Markdown string description.",
"properties": {
"archived": {
"default": false,
"description": "Whether this item is archived.",
"type": "boolean"
},
"assigneeUserGroupIds": {
"default": [],
"description": "Ids of user groups that are assigned to this item.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"assigneeUserIds": {
"default": [],
"description": "Ids of users who are assigned to this item.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"color": {
"$ref": "#/components/schemas/ItemColor",
"description": "Color of this item. If omitted, the server uses the workspace's default color."
},
"description": {
"description": "Rich text content as a markdown string (used with markdown media types)",
"examples": [
"hello **world**!"
],
"type": "string"
},
"fields": {
"additionalProperties": {},
"default": {},
"description": "Values of custom fields, where each key is a custom-field ID and each value is a JSON-formatted value of the corresponding field.",
"examples": [
{
"0fc3cfbc-27e9-3ea6-8a78-7de13dae3e3c": {
"number": 42
},
"34f05b62-dd43-3e1e-82bc-b0acabd0d004": {
"boolean": true
},
"5396681e-ea50-3d63-9ae3-c9f8ca17b7d8": {
"userGroupIds": [
"70e2b87a-b774-3022-9ef0-e55031a1c4fb"
],
"userIds": [
"24c9e15e-52af-347c-a25b-757e7bee1f9d"
]
},
"75fe57ec-4a04-3a30-8cac-5f27223df81a": {
"dateRange": {
"endDate": "2024-02-14",
"startDate": "2024-01-14",
"timezone": "UTC"
}
},
"8be74552-df93-331b-bdd6-b36ed74bdb6a": {
"selection": [
"2bb225ce-b5ee-3493-967c-fde0d72da242"
]
},
"c7824f3d-4d5f-3b2f-a2d0-34758c1e9454": {
"text": "A platform built for the new way of doing product management"
},
"e34d514f-7db5-38aa-872a-7c8191a09617": {
"date": {
"date": "2024-01-01",
"timezone": "UTC"
}
}
}
],
"type": "object"
},
"name": {
"description": "Name (title) of this item.",
"type": "string"
},
"order": {
"description": "Order number of this item for sorting. If omitted, the item is appended at the end.",
"format": "int32",
"type": "integer"
},
"statusId": {
"description": "Id of the status of this item. If omitted, the server picks a default for the workspace.",
"format": "uuid",
"type": "string"
}
},
"required": [
"name",
"description"
],
"title": "CreateItemRequestWithMD",
"type": "object"
},
"CreateMilestoneRequest": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"timezone": {
"type": "string"
}
},
"required": [
"name",
"description",
"date"
],
"title": "CreateMilestoneRequest",
"type": "object"
},
"CreateStatusPresetFromWorkspaceRequest": {
"properties": {
"name": {
"description": "Name of the status preset.",
"type": "string"
}
},
"required": [
"name"
],
"title": "CreateStatusPresetFromWorkspaceRequest",
"type": "object"
},
"CreateStatusPresetRequest": {
"properties": {
"name": {
"description": "Name of the status preset.",
"type": "string"
},
"statuses": {
"description": "Statuses to include in this preset.",
"items": {
"$ref": "#/components/schemas/Status"
},
"type": "array"
}
},
"required": [
"name",
"statuses"
],
"title": "CreateStatusPresetRequest",
"type": "object"
},
"CreateUserInviteRequest": {
"properties": {
"userId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"userId"
],
"title": "CreateUserInviteRequest",
"type": "object"
},
"CreateWorkspaceRequest": {
"properties": {
"alias": {
"description": "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.",
"type": "string"
},
"assigneeSettings": {
"$ref": "#/components/schemas/WorkspaceAssigneeSettings"
},
"defaultPermission": {
"$ref": "#/components/schemas/Permission",
"description": "Default permission for all the team members in this workspace. Note: the final permission can be adjusted corresponding to each user's role, e.g. contributors can't have more than Comment permission."
},
"description": {
"$ref": "#/components/schemas/RichText",
"description": "Description of this workspace."
},
"itemColor": {
"$ref": "#/components/schemas/ItemColor",
"description": "Default color applied to newly created items in this workspace. If not defined - a random color will be assigned to each new item."
},
"itemType": {
"$ref": "#/components/schemas/ItemType",
"description": "Type of items in this workspace."
},
"lastActivity": {
"description": "Timestamp of when any entities related to this workspace were last changed.",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of this workspace.",
"type": "string"
},
"order": {
"description": "Order number of this workspace for sorting.",
"format": "int32",
"type": "integer"
},
"progressMode": {
"$ref": "#/components/schemas/WorkspaceProgressMode",
"default": "count"
},
"statusPresetId": {
"description": "Optional reference to a shared status preset. When set, statuses are read from the preset instead of workspace-specific statuses.",
"format": "uuid",
"type": "string"
}
},
"required": [
"name",
"description",
"lastActivity",
"order"
],
"title": "CreateWorkspaceRequest",
"type": "object"
},
"CreateWorkspaceRequestWithMD": {
"description": "Workspace with Markdown string description.",
"properties": {
"alias": {
"description": "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.",
"type": "string"
},
"assigneeSettings": {
"$ref": "#/components/schemas/WorkspaceAssigneeSettings"
},
"defaultPermission": {
"$ref": "#/components/schemas/Permission",
"description": "Default permission for all the team members in this workspace. Note: the final permission can be adjusted corresponding to each user's role, e.g. contributors can't have more than Comment permission."
},
"description": {
"description": "Rich text content as a markdown string (used with markdown media types)",
"examples": [
"hello **world**!"
],
"type": "string"
},
"itemColor": {
"$ref": "#/components/schemas/ItemColor",
"description": "Default color applied to newly created items in this workspace. If not defined - a random color will be assigned to each new item."
},
"itemType": {
"$ref": "#/components/schemas/ItemType",
"description": "Type of items in this workspace."
},
"lastActivity": {
"description": "Timestamp of when any entities related to this workspace were last changed.",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of this workspace.",
"type": "string"
},
"order": {
"description": "Order number of this workspace for sorting.",
"format": "int32",
"type": "integer"
},
"progressMode": {
"$ref": "#/components/schemas/WorkspaceProgressMode",
"default": "count"
},
"statusPresetId": {
"description": "Optional reference to a shared status preset. When set, statuses are read from the preset instead of workspace-specific statuses.",
"format": "uuid",
"type": "string"
}
},
"required": [
"name",
"description",
"lastActivity",
"order"
],
"title": "CreateWorkspaceRequestWithMD",
"type": "object"
},
"DashboardViewTypeLayout": {
"properties": {
"rows": {
"items": {
"$ref": "#/components/schemas/DashboardViewTypeLayoutRow"
},
"type": "array"
}
},
"required": [
"rows"
],
"title": "DashboardViewTypeLayout",
"type": "object"
},
"DashboardViewTypeLayoutColumn": {
"properties": {
"widgetId": {
"format": "uuid",
"type": "string"
},
"width": {
"format": "double",
"type": "number"
}
},
"required": [
"widgetId",
"width"
],
"title": "DashboardViewTypeLayoutColumn",
"type": "object"
},
"DashboardViewTypeLayoutRow": {
"properties": {
"cols": {
"items": {
"$ref": "#/components/schemas/DashboardViewTypeLayoutColumn"
},
"type": "array"
},
"height": {
"format": "double",
"type": "number"
}
},
"required": [
"cols",
"height"
],
"title": "DashboardViewTypeLayoutRow",
"type": "object"
},
"DashboardViewTypeSettings": {
"properties": {
"dashboard": {
"$ref": "#/components/schemas/DashboardViewTypeSettingsDashboard"
}
},
"required": [
"dashboard"
],
"title": "DashboardViewTypeSettings",
"type": "object"
},
"DashboardViewTypeSettingsDashboard": {
"properties": {
"layout": {
"$ref": "#/components/schemas/DashboardViewTypeLayout"
},
"widgets": {
"items": {
"$ref": "#/components/schemas/DashboardViewTypeWidget"
},
"type": "array"
}
},
"required": [
"widgets",
"layout"
],
"title": "DashboardViewTypeSettingsDashboard",
"type": "object"
},
"DashboardViewTypeWidget": {
"discriminator": {
"mapping": {
"aiSummary": "#/components/schemas/AiSummaryWidget",
"capacityPlanning": "#/components/schemas/CapacityPlanningWidget",
"chart": "#/components/schemas/ChartWidget",
"itemList": "#/components/schemas/ItemListWidget",
"number": "#/components/schemas/NumberWidget",
"objective": "#/components/schemas/ObjectiveWidget"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/AiSummaryWidget"
},
{
"$ref": "#/components/schemas/CapacityPlanningWidget"
},
{
"$ref": "#/components/schemas/ChartWidget"
},
{
"$ref": "#/components/schemas/ItemListWidget"
},
{
"$ref": "#/components/schemas/NumberWidget"
},
{
"$ref": "#/components/schemas/ObjectiveWidget"
}
],
"title": "DashboardViewTypeWidget"
},
"DashboardViewWithViewEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/ViewEmbed"
},
"description": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isPrivate": {
"type": "boolean"
},
"itemFilter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"itemScopeLimit": {
"$ref": "#/components/schemas/ItemScopeLimit"
},
"itemSort": {
"items": {
"$ref": "#/components/schemas/ItemSearchQuerySort"
},
"type": "array"
},
"name": {
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"pinnedToPosition": {
"format": "int32",
"type": "integer"
},
"settings": {
"$ref": "#/components/schemas/DashboardViewTypeSettings"
},
"typeId": {
"const": "dashboard",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"typeId",
"settings",
"name",
"description",
"itemSort",
"order",
"isPrivate",
"_embedded"
],
"title": "DashboardViewWithViewEmbed",
"type": "object"
},
"DateField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "date",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "DateField",
"type": "object"
},
"DateFieldTypeFilter": {
"discriminator": {
"mapping": {
"after": "#/components/schemas/DateFieldTypeFilterAfter",
"afterOrOn": "#/components/schemas/DateFieldTypeFilterAfterOrOn",
"before": "#/components/schemas/DateFieldTypeFilterBefore",
"beforeOrOn": "#/components/schemas/DateFieldTypeFilterBeforeOrOn",
"defined": "#/components/schemas/DateFieldTypeFilterDefined",
"range": "#/components/schemas/DateFieldTypeFilterRange",
"relative": "#/components/schemas/DateFieldTypeFilterRelative"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/DateFieldTypeFilterAfter"
},
{
"$ref": "#/components/schemas/DateFieldTypeFilterAfterOrOn"
},
{
"$ref": "#/components/schemas/DateFieldTypeFilterBefore"
},
{
"$ref": "#/components/schemas/DateFieldTypeFilterBeforeOrOn"
},
{
"$ref": "#/components/schemas/DateFieldTypeFilterDefined"
},
{
"$ref": "#/components/schemas/DateFieldTypeFilterRange"
},
{
"$ref": "#/components/schemas/DateFieldTypeFilterRelative"
}
],
"title": "DateFieldTypeFilter"
},
"DateFieldTypeFilterAfter": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"type": {
"const": "after",
"type": "string"
}
},
"required": [
"date",
"type"
],
"title": "DateFieldTypeFilterAfter",
"type": "object"
},
"DateFieldTypeFilterAfterOrOn": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"type": {
"const": "afterOrOn",
"type": "string"
}
},
"required": [
"date",
"type"
],
"title": "DateFieldTypeFilterAfterOrOn",
"type": "object"
},
"DateFieldTypeFilterBefore": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"type": {
"const": "before",
"type": "string"
}
},
"required": [
"date",
"type"
],
"title": "DateFieldTypeFilterBefore",
"type": "object"
},
"DateFieldTypeFilterBeforeOrOn": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"type": {
"const": "beforeOrOn",
"type": "string"
}
},
"required": [
"date",
"type"
],
"title": "DateFieldTypeFilterBeforeOrOn",
"type": "object"
},
"DateFieldTypeFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "DateFieldTypeFilterDefined",
"type": "object"
},
"DateFieldTypeFilterRange": {
"properties": {
"from": {
"format": "date",
"type": "string"
},
"type": {
"const": "range",
"type": "string"
},
"until": {
"format": "date",
"type": "string"
}
},
"required": [
"from",
"until",
"type"
],
"title": "DateFieldTypeFilterRange",
"type": "object"
},
"DateFieldTypeFilterRelative": {
"properties": {
"anchor": {
"$ref": "#/components/schemas/ItemSearchQueryTimeAnchor"
},
"type": {
"const": "relative",
"type": "string"
}
},
"required": [
"anchor",
"type"
],
"title": "DateFieldTypeFilterRelative",
"type": "object"
},
"DateFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "date",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "DateFieldWithFieldEmbed",
"type": "object"
},
"DateRangeField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "date-range",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "DateRangeField",
"type": "object"
},
"DateRangeFieldTypeFilter": {
"discriminator": {
"mapping": {
"defined": "#/components/schemas/DateRangeFieldTypeFilterDefined",
"endBefore": "#/components/schemas/DateRangeFieldTypeFilterEndBefore",
"endBeforeOrOn": "#/components/schemas/DateRangeFieldTypeFilterEndBeforeOrOn",
"startAfter": "#/components/schemas/DateRangeFieldTypeFilterStartAfter",
"startAfterOrOn": "#/components/schemas/DateRangeFieldTypeFilterStartAfterOrOn"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/DateRangeFieldTypeFilterDefined"
},
{
"$ref": "#/components/schemas/DateRangeFieldTypeFilterEndBefore"
},
{
"$ref": "#/components/schemas/DateRangeFieldTypeFilterEndBeforeOrOn"
},
{
"$ref": "#/components/schemas/DateRangeFieldTypeFilterStartAfter"
},
{
"$ref": "#/components/schemas/DateRangeFieldTypeFilterStartAfterOrOn"
}
],
"title": "DateRangeFieldTypeFilter"
},
"DateRangeFieldTypeFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "DateRangeFieldTypeFilterDefined",
"type": "object"
},
"DateRangeFieldTypeFilterEndBefore": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"type": {
"const": "endBefore",
"type": "string"
}
},
"required": [
"date",
"type"
],
"title": "DateRangeFieldTypeFilterEndBefore",
"type": "object"
},
"DateRangeFieldTypeFilterEndBeforeOrOn": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"type": {
"const": "endBeforeOrOn",
"type": "string"
}
},
"required": [
"date",
"type"
],
"title": "DateRangeFieldTypeFilterEndBeforeOrOn",
"type": "object"
},
"DateRangeFieldTypeFilterStartAfter": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"type": {
"const": "startAfter",
"type": "string"
}
},
"required": [
"date",
"type"
],
"title": "DateRangeFieldTypeFilterStartAfter",
"type": "object"
},
"DateRangeFieldTypeFilterStartAfterOrOn": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"type": {
"const": "startAfterOrOn",
"type": "string"
}
},
"required": [
"date",
"type"
],
"title": "DateRangeFieldTypeFilterStartAfterOrOn",
"type": "object"
},
"DateRangeFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "date-range",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "DateRangeFieldWithFieldEmbed",
"type": "object"
},
"Direction": {
"enum": [
"asc",
"desc"
],
"title": "Direction",
"type": "string"
},
"DocumentContent": {
"discriminator": {
"mapping": {
"custom": "#/components/schemas/DocumentContentCustom"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/DocumentContentCustom"
}
],
"title": "DocumentContent"
},
"DocumentContentCustom": {
"properties": {
"content": {
"$ref": "#/components/schemas/RichText",
"description": "Rich text content as structured blocks. Different media types provide markdown support:\n• application/json - Default blocks format\n• application/vnd.airfocus.markdown+json - All RichText fields become markdown strings (recommended)\n• application/json+markdown - Legacy format, only top-level fields converted to markdown"
},
"type": {
"const": "custom",
"type": "string"
}
},
"required": [
"content",
"type"
],
"title": "DocumentContentCustom",
"type": "object"
},
"DocumentViewTypeSettings": {
"properties": {
"document": {
"$ref": "#/components/schemas/DocumentContent"
}
},
"required": [
"document"
],
"title": "DocumentViewTypeSettings",
"type": "object"
},
"DocumentViewWithViewEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/ViewEmbed"
},
"description": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isPrivate": {
"type": "boolean"
},
"itemFilter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"itemScopeLimit": {
"$ref": "#/components/schemas/ItemScopeLimit"
},
"itemSort": {
"items": {
"$ref": "#/components/schemas/ItemSearchQuerySort"
},
"type": "array"
},
"name": {
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"pinnedToPosition": {
"format": "int32",
"type": "integer"
},
"settings": {
"$ref": "#/components/schemas/DocumentViewTypeSettings"
},
"typeId": {
"const": "document",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"typeId",
"settings",
"name",
"description",
"itemSort",
"order",
"isPrivate",
"_embedded"
],
"title": "DocumentViewWithViewEmbed",
"type": "object"
},
"EmbedContentMode": {
"discriminator": {
"mapping": {
"custom": "#/components/schemas/EmbedContentModeCustom",
"url": "#/components/schemas/EmbedContentModeUrl"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/EmbedContentModeCustom"
},
{
"$ref": "#/components/schemas/EmbedContentModeUrl"
}
],
"title": "EmbedContentMode"
},
"EmbedContentModeCustom": {
"properties": {
"content": {
"type": "string"
},
"type": {
"const": "custom",
"type": "string"
}
},
"required": [
"content",
"type"
],
"title": "EmbedContentModeCustom",
"type": "object"
},
"EmbedContentModeUrl": {
"properties": {
"type": {
"const": "url",
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"url",
"type"
],
"title": "EmbedContentModeUrl",
"type": "object"
},
"EmbedViewTypeSettings": {
"properties": {
"embed": {
"$ref": "#/components/schemas/EmbedContentMode"
}
},
"required": [
"embed"
],
"title": "EmbedViewTypeSettings",
"type": "object"
},
"EmbedViewWithViewEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/ViewEmbed"
},
"description": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isPrivate": {
"type": "boolean"
},
"itemFilter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"itemScopeLimit": {
"$ref": "#/components/schemas/ItemScopeLimit"
},
"itemSort": {
"items": {
"$ref": "#/components/schemas/ItemSearchQuerySort"
},
"type": "array"
},
"name": {
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"pinnedToPosition": {
"format": "int32",
"type": "integer"
},
"settings": {
"$ref": "#/components/schemas/EmbedViewTypeSettings"
},
"typeId": {
"const": "embed",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"typeId",
"settings",
"name",
"description",
"itemSort",
"order",
"isPrivate",
"_embedded"
],
"title": "EmbedViewWithViewEmbed",
"type": "object"
},
"Emoji": {
"enum": [
"blue_heart",
"clap",
"confused",
"eyes",
"+1",
"rocket",
"thinking_face",
"white_check_mark"
],
"title": "Emoji",
"type": "string"
},
"ErrorResponse": {
"description": "A general error response which is returned by the server for all handled errors.",
"properties": {
"code": {
"description": "Machine readable code",
"examples": [
"not_found"
],
"type": "string"
},
"data": {
"description": "Additional informational data about the error",
"type": "object"
},
"message": {
"description": "Error messages",
"examples": [
"Entity not found"
],
"type": "string"
}
},
"required": [
"code",
"message",
"data"
],
"title": "ErrorResponse",
"type": "object"
},
"ExportTemplateRequest": {
"properties": {
"exportUsers": {
"default": false,
"description": "Whether to export user-related data (assignees, people-fields, etc).",
"type": "boolean"
},
"exportWorkspaceGroups": {
"default": false,
"description": "Whether to also export a parent group of the exported workspaces.",
"type": "boolean"
},
"workspaceIds": {
"description": "A set of workspaces which need to be exported into a template.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"workspaceIds"
],
"title": "ExportTemplateRequest",
"type": "object"
},
"ExtensionShareLink": {
"properties": {
"branding": {
"type": "boolean"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"secret": {
"type": "string"
},
"userId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"userId",
"name",
"secret",
"branding",
"createdAt"
],
"title": "ExtensionShareLink",
"type": "object"
},
"Factor": {
"properties": {
"criteria": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"description": {
"type": "string"
},
"direction": {
"$ref": "#/components/schemas/ScoringDirection"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"description",
"criteria",
"direction"
],
"title": "Factor",
"type": "object"
},
"FactorId": {
"enum": [
"r",
"x",
"y"
],
"title": "FactorId",
"type": "string"
},
"Factors": {
"properties": {
"r": {
"$ref": "#/components/schemas/Factor"
},
"x": {
"$ref": "#/components/schemas/Factor"
},
"y": {
"$ref": "#/components/schemas/Factor"
}
},
"required": [
"y",
"x",
"r"
],
"title": "Factors",
"type": "object"
},
"Field": {
"discriminator": {
"mapping": {
"boolean": "#/components/schemas/BooleanField",
"date": "#/components/schemas/DateField",
"date-range": "#/components/schemas/DateRangeField",
"form-source": "#/components/schemas/FormSourceField",
"form-target": "#/components/schemas/FormTargetField",
"health-check-ins-field": "#/components/schemas/HealthCheckInsFieldField",
"insights": "#/components/schemas/InsightsField",
"milestone": "#/components/schemas/MilestoneField",
"mirror-source": "#/components/schemas/MirrorSourceField",
"mirror-target": "#/components/schemas/MirrorTargetField",
"number": "#/components/schemas/NumberField",
"okr-checkins": "#/components/schemas/OkrCheckinsField",
"okr-confidence": "#/components/schemas/OkrConfidenceField",
"okr-key-result-reference": "#/components/schemas/OkrKeyResultReferenceField",
"okr-key-results": "#/components/schemas/OkrKeyResultsField",
"okr-progress": "#/components/schemas/OkrProgressField",
"okr-time-period": "#/components/schemas/OkrTimePeriodField",
"people": "#/components/schemas/PeopleField",
"portal": "#/components/schemas/PortalField",
"portfolio-source": "#/components/schemas/PortfolioSourceField",
"prioritization": "#/components/schemas/PrioritizationField",
"select": "#/components/schemas/SelectField",
"text": "#/components/schemas/TextField",
"time-period": "#/components/schemas/TimePeriodField",
"votes": "#/components/schemas/VotesField",
"votingScore": "#/components/schemas/VotingScoreField"
},
"propertyName": "typeId"
},
"oneOf": [
{
"$ref": "#/components/schemas/BooleanField"
},
{
"$ref": "#/components/schemas/DateField"
},
{
"$ref": "#/components/schemas/DateRangeField"
},
{
"$ref": "#/components/schemas/FormSourceField"
},
{
"$ref": "#/components/schemas/FormTargetField"
},
{
"$ref": "#/components/schemas/HealthCheckInsFieldField"
},
{
"$ref": "#/components/schemas/InsightsField"
},
{
"$ref": "#/components/schemas/MilestoneField"
},
{
"$ref": "#/components/schemas/MirrorSourceField"
},
{
"$ref": "#/components/schemas/MirrorTargetField"
},
{
"$ref": "#/components/schemas/NumberField"
},
{
"$ref": "#/components/schemas/OkrCheckinsField"
},
{
"$ref": "#/components/schemas/OkrConfidenceField"
},
{
"$ref": "#/components/schemas/OkrKeyResultReferenceField"
},
{
"$ref": "#/components/schemas/OkrKeyResultsField"
},
{
"$ref": "#/components/schemas/OkrProgressField"
},
{
"$ref": "#/components/schemas/OkrTimePeriodField"
},
{
"$ref": "#/components/schemas/PeopleField"
},
{
"$ref": "#/components/schemas/PortalField"
},
{
"$ref": "#/components/schemas/PortfolioSourceField"
},
{
"$ref": "#/components/schemas/PrioritizationField"
},
{
"$ref": "#/components/schemas/SelectField"
},
{
"$ref": "#/components/schemas/TextField"
},
{
"$ref": "#/components/schemas/TimePeriodField"
},
{
"$ref": "#/components/schemas/VotesField"
},
{
"$ref": "#/components/schemas/VotingScoreField"
}
],
"title": "Field"
},
"FieldEmbed": {
"properties": {
"workspaces": {
"description": "List of all workspaces where this field is used.",
"items": {
"$ref": "#/components/schemas/FieldFieldWorkspaceEmbed"
},
"type": "array"
}
},
"required": [
"workspaces"
],
"title": "FieldEmbed",
"type": "object"
},
"FieldFieldWorkspaceEmbed": {
"properties": {
"order": {
"description": "Order of the field in this specific workspace.",
"examples": [
42
],
"format": "int32",
"type": "integer"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"workspaceId",
"order"
],
"title": "FieldFieldWorkspaceEmbed",
"type": "object"
},
"FieldSearchQuery": {
"properties": {
"isTeamField": {
"description": "Return only fields with the specified isTeamField value.",
"type": "boolean"
},
"required": {
"description": "Return only fields with the specified required value.",
"type": "boolean"
},
"workspaceIds": {
"default": [],
"description": "Return only fields which are installed in the specified workspaces.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"title": "FieldSearchQuery",
"type": "object"
},
"FieldToWorkspaceLink": {
"properties": {
"fieldId": {
"format": "uuid",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"fieldId",
"workspaceId"
],
"title": "FieldToWorkspaceLink",
"type": "object"
},
"FieldTypeInfo": {
"properties": {
"typeId": {
"type": "string"
}
},
"required": [
"typeId"
],
"title": "FieldTypeInfo",
"type": "object"
},
"FieldWithFieldEmbed": {
"discriminator": {
"mapping": {
"boolean": "#/components/schemas/BooleanFieldWithFieldEmbed",
"date": "#/components/schemas/DateFieldWithFieldEmbed",
"date-range": "#/components/schemas/DateRangeFieldWithFieldEmbed",
"form-source": "#/components/schemas/FormSourceFieldWithFieldEmbed",
"form-target": "#/components/schemas/FormTargetFieldWithFieldEmbed",
"health-check-ins-field": "#/components/schemas/HealthCheckInsFieldFieldWithFieldEmbed",
"insights": "#/components/schemas/InsightsFieldWithFieldEmbed",
"milestone": "#/components/schemas/MilestoneFieldWithFieldEmbed",
"mirror-source": "#/components/schemas/MirrorSourceFieldWithFieldEmbed",
"mirror-target": "#/components/schemas/MirrorTargetFieldWithFieldEmbed",
"number": "#/components/schemas/NumberFieldWithFieldEmbed",
"okr-checkins": "#/components/schemas/OkrCheckinsFieldWithFieldEmbed",
"okr-confidence": "#/components/schemas/OkrConfidenceFieldWithFieldEmbed",
"okr-key-result-reference": "#/components/schemas/OkrKeyResultReferenceFieldWithFieldEmbed",
"okr-key-results": "#/components/schemas/OkrKeyResultsFieldWithFieldEmbed",
"okr-progress": "#/components/schemas/OkrProgressFieldWithFieldEmbed",
"okr-time-period": "#/components/schemas/OkrTimePeriodFieldWithFieldEmbed",
"people": "#/components/schemas/PeopleFieldWithFieldEmbed",
"portal": "#/components/schemas/PortalFieldWithFieldEmbed",
"portfolio-source": "#/components/schemas/PortfolioSourceFieldWithFieldEmbed",
"prioritization": "#/components/schemas/PrioritizationFieldWithFieldEmbed",
"select": "#/components/schemas/SelectFieldWithFieldEmbed",
"text": "#/components/schemas/TextFieldWithFieldEmbed",
"time-period": "#/components/schemas/TimePeriodFieldWithFieldEmbed",
"votes": "#/components/schemas/VotesFieldWithFieldEmbed",
"votingScore": "#/components/schemas/VotingScoreFieldWithFieldEmbed"
},
"propertyName": "typeId"
},
"oneOf": [
{
"$ref": "#/components/schemas/BooleanFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/DateFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/DateRangeFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/FormSourceFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/FormTargetFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/HealthCheckInsFieldFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/InsightsFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/MilestoneFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/MirrorSourceFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/MirrorTargetFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/NumberFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/OkrCheckinsFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/OkrConfidenceFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/OkrKeyResultReferenceFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/OkrKeyResultsFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/OkrProgressFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/OkrTimePeriodFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/PeopleFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/PortalFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/PortfolioSourceFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/PrioritizationFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/SelectFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/TextFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/TimePeriodFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/VotesFieldWithFieldEmbed"
},
{
"$ref": "#/components/schemas/VotingScoreFieldWithFieldEmbed"
}
],
"title": "FieldWithFieldEmbed"
},
"FieldWithFieldEmbedPage": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/FieldWithFieldEmbed"
},
"type": "array"
},
"totalItems": {
"format": "int32",
"type": "integer"
}
},
"required": [
"items",
"totalItems"
],
"title": "FieldWithFieldEmbedPage",
"type": "object"
},
"FormAudience": {
"discriminator": {
"mapping": {
"anonymousUsers": "#/components/schemas/FormAudienceAnonymousUsers",
"teamMembers": "#/components/schemas/FormAudienceTeamMembers"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/FormAudienceAnonymousUsers"
},
{
"$ref": "#/components/schemas/FormAudienceTeamMembers"
}
],
"title": "FormAudience"
},
"FormAudienceAnonymousUsers": {
"properties": {
"type": {
"const": "anonymousUsers",
"type": "string"
}
},
"required": [
"type"
],
"title": "FormAudienceAnonymousUsers",
"type": "object"
},
"FormAudienceTeamMembers": {
"properties": {
"type": {
"const": "teamMembers",
"type": "string"
}
},
"required": [
"type"
],
"title": "FormAudienceTeamMembers",
"type": "object"
},
"FormSourceField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/FormSourceFieldTypeSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "form-source",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "FormSourceField",
"type": "object"
},
"FormSourceFieldTypeFilter": {
"discriminator": {
"mapping": {
"contain": "#/components/schemas/FormSourceFieldTypeFilterContain",
"defined": "#/components/schemas/FormSourceFieldTypeFilterDefined"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/FormSourceFieldTypeFilterContain"
},
{
"$ref": "#/components/schemas/FormSourceFieldTypeFilterDefined"
}
],
"title": "FormSourceFieldTypeFilter"
},
"FormSourceFieldTypeFilterContain": {
"properties": {
"itemId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "contain",
"type": "string"
}
},
"required": [
"itemId",
"type"
],
"title": "FormSourceFieldTypeFilterContain",
"type": "object"
},
"FormSourceFieldTypeFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "FormSourceFieldTypeFilterDefined",
"type": "object"
},
"FormSourceFieldTypeSettings": {
"properties": {
"maximum": {
"format": "int32",
"type": "integer"
}
},
"title": "FormSourceFieldTypeSettings",
"type": "object"
},
"FormSourceFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/FormSourceFieldTypeSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "form-source",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "FormSourceFieldWithFieldEmbed",
"type": "object"
},
"FormTargetField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "form-target",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "FormTargetField",
"type": "object"
},
"FormTargetFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "form-target",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "FormTargetFieldWithFieldEmbed",
"type": "object"
},
"FormsApp": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/FormsAppTypeSettings"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "forms",
"type": "string"
}
},
"required": [
"id",
"teamId",
"typeId",
"settings"
],
"title": "FormsApp",
"type": "object"
},
"FormsAppTypeFieldSettings": {
"properties": {
"fieldId": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"required": {
"type": "boolean"
}
},
"required": [
"fieldId",
"required",
"order"
],
"title": "FormsAppTypeFieldSettings",
"type": "object"
},
"FormsAppTypeSettings": {
"properties": {
"audience": {
"items": {
"$ref": "#/components/schemas/FormAudience"
},
"type": "array"
},
"descriptionName": {
"type": "string"
},
"descriptionOrder": {
"format": "int32",
"type": "integer"
},
"fields": {
"items": {
"$ref": "#/components/schemas/FormsAppTypeFieldSettings"
},
"type": "array",
"uniqueItems": true
},
"formDescription": {
"type": "string"
},
"formSourceFieldId": {
"format": "uuid",
"type": "string"
},
"formTargetFieldId": {
"format": "uuid",
"type": "string"
},
"formType": {
"$ref": "#/components/schemas/FormsAppTypeSettingsFormType"
},
"requireLogin": {
"type": "boolean"
},
"shareLinks": {
"items": {
"$ref": "#/components/schemas/ExtensionShareLink"
},
"type": "array"
},
"subjectName": {
"type": "string"
},
"targetWorkspaceId": {
"format": "uuid",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"workspaceId",
"targetWorkspaceId",
"descriptionOrder",
"formSourceFieldId",
"formTargetFieldId",
"fields",
"formDescription",
"formType",
"audience",
"requireLogin",
"shareLinks"
],
"title": "FormsAppTypeSettings",
"type": "object"
},
"FormsAppTypeSettingsFormType": {
"properties": {
"general": {
"$ref": "#/components/schemas/FormsAppTypeSettingsFormTypeSettings"
},
"item": {
"$ref": "#/components/schemas/FormsAppTypeSettingsFormTypeSettings"
}
},
"required": [
"general",
"item"
],
"title": "FormsAppTypeSettingsFormType",
"type": "object"
},
"FormsAppTypeSettingsFormTypeSettings": {
"properties": {
"enabled": {
"type": "boolean"
},
"label": {
"type": "string"
}
},
"required": [
"enabled",
"label"
],
"title": "FormsAppTypeSettingsFormTypeSettings",
"type": "object"
},
"FormsTargetFieldTypeFilter": {
"discriminator": {
"mapping": {
"defined": "#/components/schemas/FormsTargetFieldTypeFilterDefined"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/FormsTargetFieldTypeFilterDefined"
}
],
"title": "FormsTargetFieldTypeFilter"
},
"FormsTargetFieldTypeFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "FormsTargetFieldTypeFilterDefined",
"type": "object"
},
"GanttViewTypeSettings": {
"properties": {
"colorMode": {
"$ref": "#/components/schemas/ColorMode"
},
"groupBy": {
"default": [],
"items": {
"$ref": "#/components/schemas/GroupBy"
},
"type": "array"
},
"showAlias": {
"default": false,
"type": "boolean"
},
"showAssignees": {
"default": false,
"type": "boolean"
},
"showDependencies": {
"default": false,
"type": "boolean"
},
"showFieldIds": {
"default": [],
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"showFieldTypes": {
"default": [],
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"showIntegrations": {
"default": false,
"type": "boolean"
},
"showMilestones": {
"default": false,
"type": "boolean"
},
"showProgress": {
"default": true,
"type": "boolean"
},
"showStatus": {
"default": true,
"type": "boolean"
},
"timingFieldIds": {
"additionalProperties": {
"format": "uuid",
"type": "string"
},
"type": "object"
},
"zoom": {
"$ref": "#/components/schemas/GanttViewTypeZoom"
}
},
"required": [
"timingFieldIds"
],
"title": "GanttViewTypeSettings",
"type": "object"
},
"GanttViewTypeZoom": {
"default": "monthly",
"enum": [
"daily",
"monthly",
"quarterly",
"weekly",
"yearly"
],
"title": "GanttViewTypeZoom",
"type": "string"
},
"GanttViewWithViewEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/ViewEmbed"
},
"description": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isPrivate": {
"type": "boolean"
},
"itemFilter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"itemScopeLimit": {
"$ref": "#/components/schemas/ItemScopeLimit"
},
"itemSort": {
"items": {
"$ref": "#/components/schemas/ItemSearchQuerySort"
},
"type": "array"
},
"name": {
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"pinnedToPosition": {
"format": "int32",
"type": "integer"
},
"settings": {
"$ref": "#/components/schemas/GanttViewTypeSettings"
},
"typeId": {
"const": "gantt",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"typeId",
"settings",
"name",
"description",
"itemSort",
"order",
"isPrivate",
"_embedded"
],
"title": "GanttViewWithViewEmbed",
"type": "object"
},
"GetItemsAnalyticsRequest": {
"discriminator": {
"mapping": {
"breakdown": "#/components/schemas/GetItemsAnalyticsRequestBreakdown",
"number": "#/components/schemas/GetItemsAnalyticsRequestNumber"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/GetItemsAnalyticsRequestBreakdown"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsRequestNumber"
}
],
"title": "GetItemsAnalyticsRequest"
},
"GetItemsAnalyticsRequestBreakdown": {
"properties": {
"breakdown": {
"$ref": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurableProperty",
"description": "Property and setting used for breakdown"
},
"includeArchived": {
"default": false,
"description": "Includes archived items or not, default: false",
"type": "boolean"
},
"itemFilter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"description": "Filter applied on the items",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"segment": {
"$ref": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurableProperty",
"description": "Property used for segment"
},
"type": {
"const": "breakdown",
"type": "string"
}
},
"required": [
"breakdown",
"type"
],
"title": "GetItemsAnalyticsRequestBreakdown",
"type": "object"
},
"GetItemsAnalyticsRequestBreakdownConfigurableProperty": {
"properties": {
"property": {
"$ref": "#/components/schemas/GetItemsAnalyticsRequestProperty"
},
"setting": {
"$ref": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurablePropertySetting"
}
},
"required": [
"property"
],
"title": "GetItemsAnalyticsRequestBreakdownConfigurableProperty",
"type": "object"
},
"GetItemsAnalyticsRequestBreakdownConfigurablePropertySetting": {
"description": "Specific bucket setting used for breakdown",
"discriminator": {
"mapping": {
"grouping:auto": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingAuto",
"grouping:bucketCount": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingBucketCount",
"grouping:interval": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingInterval",
"period:daily": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodDaily",
"period:monthly": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodMonthly",
"period:quarterly": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodQuarterly",
"period:weekly": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodWeekly",
"period:yearly": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodYearly"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingAuto"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingBucketCount"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingInterval"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodDaily"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodMonthly"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodQuarterly"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodWeekly"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodYearly"
}
],
"title": "GetItemsAnalyticsRequestBreakdownConfigurablePropertySetting"
},
"GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingAuto": {
"properties": {
"type": {
"const": "grouping:auto",
"type": "string"
}
},
"required": [
"type"
],
"title": "GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingAuto",
"type": "object"
},
"GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingBucketCount": {
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"type": {
"const": "grouping:bucketCount",
"type": "string"
}
},
"required": [
"count",
"type"
],
"title": "GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingBucketCount",
"type": "object"
},
"GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingInterval": {
"properties": {
"interval": {
"type": "number"
},
"type": {
"const": "grouping:interval",
"type": "string"
}
},
"required": [
"interval",
"type"
],
"title": "GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingGroupingInterval",
"type": "object"
},
"GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodDaily": {
"properties": {
"type": {
"const": "period:daily",
"type": "string"
}
},
"required": [
"type"
],
"title": "GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodDaily",
"type": "object"
},
"GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodMonthly": {
"properties": {
"type": {
"const": "period:monthly",
"type": "string"
}
},
"required": [
"type"
],
"title": "GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodMonthly",
"type": "object"
},
"GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodQuarterly": {
"properties": {
"type": {
"const": "period:quarterly",
"type": "string"
}
},
"required": [
"type"
],
"title": "GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodQuarterly",
"type": "object"
},
"GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodWeekly": {
"properties": {
"type": {
"const": "period:weekly",
"type": "string"
}
},
"required": [
"type"
],
"title": "GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodWeekly",
"type": "object"
},
"GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodYearly": {
"properties": {
"type": {
"const": "period:yearly",
"type": "string"
}
},
"required": [
"type"
],
"title": "GetItemsAnalyticsRequestBreakdownConfigurablePropertySettingPeriodYearly",
"type": "object"
},
"GetItemsAnalyticsRequestNumber": {
"properties": {
"includeArchived": {
"default": false,
"description": "Includes archived items or not, default: false",
"type": "boolean"
},
"itemFilter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"description": "Filter applied on the items",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"type": {
"const": "number",
"type": "string"
}
},
"required": [
"type"
],
"title": "GetItemsAnalyticsRequestNumber",
"type": "object"
},
"GetItemsAnalyticsRequestProperty": {
"description": "Item property",
"discriminator": {
"mapping": {
"completionDate": "#/components/schemas/GetItemsAnalyticsRequestPropertyCompletionDate",
"completionTime": "#/components/schemas/GetItemsAnalyticsRequestPropertyCompletionTime",
"fieldType": "#/components/schemas/GetItemsAnalyticsRequestPropertyFieldType",
"itemRef": "#/components/schemas/GetItemsAnalyticsRequestPropertyItemRef",
"keyResult": "#/components/schemas/GetItemsAnalyticsRequestPropertyKeyResult",
"objective": "#/components/schemas/GetItemsAnalyticsRequestPropertyObjective",
"statusCategory": "#/components/schemas/GetItemsAnalyticsRequestPropertyStatusCategory"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/GetItemsAnalyticsRequestPropertyCompletionDate"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsRequestPropertyCompletionTime"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsRequestPropertyFieldType"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsRequestPropertyItemRef"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsRequestPropertyKeyResult"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsRequestPropertyObjective"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsRequestPropertyStatusCategory"
}
],
"title": "GetItemsAnalyticsRequestProperty"
},
"GetItemsAnalyticsRequestPropertyCompletionDate": {
"properties": {
"type": {
"const": "completionDate",
"type": "string"
}
},
"required": [
"type"
],
"title": "GetItemsAnalyticsRequestPropertyCompletionDate",
"type": "object"
},
"GetItemsAnalyticsRequestPropertyCompletionTime": {
"properties": {
"type": {
"const": "completionTime",
"type": "string"
}
},
"required": [
"type"
],
"title": "GetItemsAnalyticsRequestPropertyCompletionTime",
"type": "object"
},
"GetItemsAnalyticsRequestPropertyFieldType": {
"properties": {
"fieldType": {
"enum": [
"insights",
"prioritization",
"health-check-ins-field",
"votingScore"
],
"type": "string"
},
"type": {
"const": "fieldType",
"type": "string"
}
},
"required": [
"fieldType",
"type"
],
"title": "GetItemsAnalyticsRequestPropertyFieldType",
"type": "object"
},
"GetItemsAnalyticsRequestPropertyItemRef": {
"properties": {
"ref": {
"$ref": "#/components/schemas/RefItemProperty"
},
"type": {
"const": "itemRef",
"type": "string"
}
},
"required": [
"ref",
"type"
],
"title": "GetItemsAnalyticsRequestPropertyItemRef",
"type": "object"
},
"GetItemsAnalyticsRequestPropertyKeyResult": {
"properties": {
"type": {
"const": "keyResult",
"type": "string"
}
},
"required": [
"type"
],
"title": "GetItemsAnalyticsRequestPropertyKeyResult",
"type": "object"
},
"GetItemsAnalyticsRequestPropertyObjective": {
"properties": {
"type": {
"const": "objective",
"type": "string"
}
},
"required": [
"type"
],
"title": "GetItemsAnalyticsRequestPropertyObjective",
"type": "object"
},
"GetItemsAnalyticsRequestPropertyStatusCategory": {
"properties": {
"type": {
"const": "statusCategory",
"type": "string"
}
},
"required": [
"type"
],
"title": "GetItemsAnalyticsRequestPropertyStatusCategory",
"type": "object"
},
"GetItemsAnalyticsResponse": {
"discriminator": {
"mapping": {
"breakdown": "#/components/schemas/GetItemsAnalyticsResponseBreakdown",
"error": "#/components/schemas/GetItemsAnalyticsResponseError",
"number": "#/components/schemas/GetItemsAnalyticsResponseNumber"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdown"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsResponseError"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsResponseNumber"
}
],
"title": "GetItemsAnalyticsResponse"
},
"GetItemsAnalyticsResponseBreakdown": {
"properties": {
"breakdown": {
"description": "Buckets with items",
"items": {
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBreakdownBucket"
},
"type": "array"
},
"buckets": {
"additionalProperties": {
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucket"
},
"description": "Buckets descriptions",
"type": "object"
},
"itemCount": {
"description": "Count of unique items in the breakdowns",
"format": "int64",
"type": "integer"
},
"type": {
"const": "breakdown",
"type": "string"
}
},
"required": [
"itemCount",
"breakdown",
"buckets",
"type"
],
"title": "GetItemsAnalyticsResponseBreakdown",
"type": "object"
},
"GetItemsAnalyticsResponseBreakdownBreakdownBucket": {
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"id": {
"format": "uuid",
"type": "string"
},
"segments": {
"items": {
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdownSegmentBucket"
},
"type": "array"
}
},
"required": [
"id",
"count",
"segments"
],
"title": "GetItemsAnalyticsResponseBreakdownBreakdownBucket",
"type": "object"
},
"GetItemsAnalyticsResponseBreakdownBucket": {
"discriminator": {
"mapping": {
"confidence": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketConfidence",
"date": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketDate",
"empty": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketEmpty",
"keyResult": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketKeyResult",
"milestone": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketMilestone",
"numeric": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketNumeric",
"objective": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketObjective",
"people": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketPeople",
"property": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketProperty",
"select": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketSelect",
"status": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketStatus",
"statusCategory": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketStatusCategory",
"timePeriod": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketTimePeriod",
"workspace": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketWorkspace"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketConfidence"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketDate"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketEmpty"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketKeyResult"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketMilestone"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketNumeric"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketObjective"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketPeople"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketProperty"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketSelect"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketStatus"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketStatusCategory"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketTimePeriod"
},
{
"$ref": "#/components/schemas/GetItemsAnalyticsResponseBreakdownBucketWorkspace"
}
],
"title": "GetItemsAnalyticsResponseBreakdownBucket"
},
"GetItemsAnalyticsResponseBreakdownBucketConfidence": {
"properties": {
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"const": "confidence",
"type": "string"
}
},
"required": [
"id",
"name",
"filter",
"type"
],
"title": "GetItemsAnalyticsResponseBreakdownBucketConfidence",
"type": "object"
},
"GetItemsAnalyticsResponseBreakdownBucketDate": {
"properties": {
"end": {
"format": "date",
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"start": {
"format": "date",
"type": "string"
},
"type": {
"const": "date",
"type": "string"
}
},
"required": [
"id",
"name",
"start",
"end",
"filter",
"type"
],
"title": "GetItemsAnalyticsResponseBreakdownBucketDate",
"type": "object"
},
"GetItemsAnalyticsResponseBreakdownBucketEmpty": {
"properties": {
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"default": "None",
"description": "Always 'None'",
"type": "string"
},
"type": {
"const": "empty",
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "GetItemsAnalyticsResponseBreakdownBucketEmpty",
"type": "object"
},
"GetItemsAnalyticsResponseBreakdownBucketKeyResult": {
"properties": {
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"id": {
"format": "uuid",
"type": "string"
},
"keyResultId": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"objectiveItemId": {
"format": "uuid",
"type": "string"
},
"objectiveWorkspaceId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "keyResult",
"type": "string"
}
},
"required": [
"id",
"name",
"objectiveWorkspaceId",
"objectiveItemId",
"keyResultId",
"filter",
"type"
],
"title": "GetItemsAnalyticsResponseBreakdownBucketKeyResult",
"type": "object"
},
"GetItemsAnalyticsResponseBreakdownBucketMilestone": {
"properties": {
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"id": {
"format": "uuid",
"type": "string"
},
"milestoneId": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"const": "milestone",
"type": "string"
}
},
"required": [
"id",
"name",
"milestoneId",
"filter",
"type"
],
"title": "GetItemsAnalyticsResponseBreakdownBucketMilestone",
"type": "object"
},
"GetItemsAnalyticsResponseBreakdownBucketNumeric": {
"properties": {
"end": {
"type": "number"
},
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"start": {
"type": "number"
},
"type": {
"const": "numeric",
"type": "string"
},
"unit": {
"$ref": "#/components/schemas/NumberFieldTypeSettingsUnit"
}
},
"required": [
"id",
"name",
"start",
"end",
"filter",
"type"
],
"title": "GetItemsAnalyticsResponseBreakdownBucketNumeric",
"type": "object"
},
"GetItemsAnalyticsResponseBreakdownBucketObjective": {
"properties": {
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"objectiveItemId": {
"format": "uuid",
"type": "string"
},
"objectiveWorkspaceId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "objective",
"type": "string"
}
},
"required": [
"id",
"name",
"objectiveWorkspaceId",
"objectiveItemId",
"filter",
"type"
],
"title": "GetItemsAnalyticsResponseBreakdownBucketObjective",
"type": "object"
},
"GetItemsAnalyticsResponseBreakdownBucketPeople": {
"properties": {
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"const": "people",
"type": "string"
},
"userRef": {
"$ref": "#/components/schemas/UserRef"
}
},
"required": [
"id",
"name",
"userRef",
"filter",
"type"
],
"title": "GetItemsAnalyticsResponseBreakdownBucketPeople",
"type": "object"
},
"GetItemsAnalyticsResponseBreakdownBucketProperty": {
"properties": {
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"const": "property",
"type": "string"
}
},
"required": [
"id",
"name",
"filter",
"type"
],
"title": "GetItemsAnalyticsResponseBreakdownBucketProperty",
"type": "object"
},
"GetItemsAnalyticsResponseBreakdownBucketSelect": {
"properties": {
"color": {
"$ref": "#/components/schemas/SelectFieldOptionColor"
},
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"selectId": {
"type": "string"
},
"type": {
"const": "select",
"type": "string"
}
},
"required": [
"id",
"name",
"selectId",
"filter",
"type"
],
"title": "GetItemsAnalyticsResponseBreakdownBucketSelect",
"type": "object"
},
"GetItemsAnalyticsResponseBreakdownBucketStatus": {
"properties": {
"category": {
"$ref": "#/components/schemas/StatusCategory"
},
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"statusId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "status",
"type": "string"
}
},
"required": [
"id",
"name",
"statusId",
"category",
"filter",
"type"
],
"title": "GetItemsAnalyticsResponseBreakdownBucketStatus",
"type": "object"
},
"GetItemsAnalyticsResponseBreakdownBucketStatusCategory": {
"properties": {
"category": {
"$ref": "#/components/schemas/StatusCategory"
},
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"const": "statusCategory",
"type": "string"
}
},
"required": [
"id",
"name",
"category",
"filter",
"type"
],
"title": "GetItemsAnalyticsResponseBreakdownBucketStatusCategory",
"type": "object"
},
"GetItemsAnalyticsResponseBreakdownBucketTimePeriod": {
"properties": {
"end": {
"format": "date",
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"start": {
"format": "date",
"type": "string"
},
"timePeriodId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "timePeriod",
"type": "string"
}
},
"required": [
"id",
"name",
"timePeriodId",
"start",
"end",
"filter",
"type"
],
"title": "GetItemsAnalyticsResponseBreakdownBucketTimePeriod",
"type": "object"
},
"GetItemsAnalyticsResponseBreakdownBucketWorkspace": {
"properties": {
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"id": {
"format": "uuid",
"type": "string"
},
"itemColor": {
"$ref": "#/components/schemas/ItemColor"
},
"itemType": {
"$ref": "#/components/schemas/ItemType"
},
"name": {
"type": "string"
},
"type": {
"const": "workspace",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"name",
"workspaceId",
"filter",
"type"
],
"title": "GetItemsAnalyticsResponseBreakdownBucketWorkspace",
"type": "object"
},
"GetItemsAnalyticsResponseBreakdownSegmentBucket": {
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"id": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"count"
],
"title": "GetItemsAnalyticsResponseBreakdownSegmentBucket",
"type": "object"
},
"GetItemsAnalyticsResponseError": {
"properties": {
"reason": {
"type": "string"
},
"type": {
"const": "error",
"type": "string"
}
},
"required": [
"reason",
"type"
],
"title": "GetItemsAnalyticsResponseError",
"type": "object"
},
"GetItemsAnalyticsResponseNumber": {
"properties": {
"itemCount": {
"description": "Count of unique items",
"format": "int64",
"type": "integer"
},
"type": {
"const": "number",
"type": "string"
}
},
"required": [
"itemCount",
"type"
],
"title": "GetItemsAnalyticsResponseNumber",
"type": "object"
},
"GithubIntegrationSummary": {
"properties": {
"capabilities": {
"$ref": "#/components/schemas/IntegrationCapabilities"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"lastSyncAt": {
"format": "date-time",
"type": "string"
},
"lastSyncState": {
"$ref": "#/components/schemas/IntegrationSyncState"
},
"settings": {
"$ref": "#/components/schemas/GithubIntegrationTypeSettings"
},
"typeId": {
"const": "github",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"createdAt",
"capabilities",
"enabled"
],
"title": "GithubIntegrationSummary",
"type": "object"
},
"GithubIntegrationTypeSettings": {
"properties": {
"accessToken": {
"type": "string"
},
"addLabel": {
"format": "int64",
"type": "integer"
},
"autoSync": {
"type": "boolean"
},
"mapSelectFieldAndLabels": {
"$ref": "#/components/schemas/GithubIntegrationTypeSettingsLabelMapping"
},
"mappings": {
"default": [],
"items": {
"$ref": "#/components/schemas/MappingSettingsIntegrationMappingSettings"
},
"type": "array"
},
"removeExtraneous": {
"type": "boolean"
},
"selectLabels": {
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"selectRepository": {
"format": "int64",
"type": "integer"
},
"title": {
"type": "string"
},
"twoWay": {
"type": "boolean"
}
},
"required": [
"removeExtraneous",
"twoWay",
"autoSync"
],
"title": "GithubIntegrationTypeSettings",
"type": "object"
},
"GithubIntegrationTypeSettingsLabelMapping": {
"properties": {
"fieldId": {
"format": "uuid",
"type": "string"
},
"pairs": {
"items": {
"$ref": "#/components/schemas/GithubIntegrationTypeSettingsLabelMappingPair"
},
"type": "array"
}
},
"required": [
"fieldId",
"pairs"
],
"title": "GithubIntegrationTypeSettingsLabelMapping",
"type": "object"
},
"GithubIntegrationTypeSettingsLabelMappingPair": {
"properties": {
"labelId": {
"format": "int64",
"type": "integer"
},
"optionId": {
"type": "string"
}
},
"required": [
"optionId",
"labelId"
],
"title": "GithubIntegrationTypeSettingsLabelMappingPair",
"type": "object"
},
"GlobalSearchQuery": {
"default": {
"archived": false,
"assigneeUserGroupIds": [],
"assigneeUserIds": [],
"searchTargets": [],
"statusCategories": [],
"workspaceIds": []
},
"properties": {
"archived": {
"default": false,
"description": "Search only archived or only non-archived items (only non-archived by default)",
"type": "boolean"
},
"assigneeUserGroupIds": {
"default": [],
"description": "Narrow down the search to items which are assigned to the specified user groups",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"assigneeUserIds": {
"default": [],
"description": "Narrow down the search to items which are assigned to the specified users",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"contextQuery": {
"description": "Context-string for AI to match items by similarity",
"type": "string"
},
"searchQuery": {
"description": "Text to search in contents of items",
"type": "string"
},
"searchTargets": {
"default": [],
"description": "Narrow down the search to specific targeted fields, exclusive.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"statusCategories": {
"default": [],
"description": "Narrow down the search to items with status in the specified status-categories",
"items": {
"$ref": "#/components/schemas/StatusCategory"
},
"type": "array"
},
"workspaceIds": {
"default": [],
"description": "Narrow down the search to specific workspaces",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"title": "GlobalSearchQuery",
"type": "object"
},
"GlobalSearchResult": {
"discriminator": {
"mapping": {
"item": "#/components/schemas/GlobalSearchResultItem"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/GlobalSearchResultItem"
}
],
"title": "GlobalSearchResult"
},
"GlobalSearchResultItem": {
"properties": {
"alias": {
"type": "string"
},
"score": {
"format": "float",
"type": "number"
},
"type": {
"const": "item",
"type": "string"
},
"value": {
"$ref": "#/components/schemas/Item"
}
},
"required": [
"value",
"type"
],
"title": "GlobalSearchResultItem",
"type": "object"
},
"GlobalSearchResultPage": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/GlobalSearchResult"
},
"type": "array"
},
"totalItems": {
"format": "int32",
"type": "integer"
}
},
"required": [
"items",
"totalItems"
],
"title": "GlobalSearchResultPage",
"type": "object"
},
"GroupBy": {
"discriminator": {
"mapping": {
"app": "#/components/schemas/GroupByApp",
"assignees": "#/components/schemas/GroupByAssignees",
"field": "#/components/schemas/GroupByField",
"fieldType": "#/components/schemas/GroupByFieldType",
"parent": "#/components/schemas/GroupByParent",
"status": "#/components/schemas/GroupByStatus",
"statusCategory": "#/components/schemas/GroupByStatusCategory"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/GroupByApp"
},
{
"$ref": "#/components/schemas/GroupByAssignees"
},
{
"$ref": "#/components/schemas/GroupByField"
},
{
"$ref": "#/components/schemas/GroupByFieldType"
},
{
"$ref": "#/components/schemas/GroupByParent"
},
{
"$ref": "#/components/schemas/GroupByStatus"
},
{
"$ref": "#/components/schemas/GroupByStatusCategory"
}
],
"title": "GroupBy"
},
"GroupByApp": {
"properties": {
"appId": {
"format": "uuid",
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/GroupBySettings"
},
"type": {
"const": "app",
"type": "string"
}
},
"required": [
"appId",
"settings",
"type"
],
"title": "GroupByApp",
"type": "object"
},
"GroupByAssignees": {
"properties": {
"settings": {
"$ref": "#/components/schemas/GroupBySettings"
},
"type": {
"const": "assignees",
"type": "string"
}
},
"required": [
"settings",
"type"
],
"title": "GroupByAssignees",
"type": "object"
},
"GroupByField": {
"properties": {
"fieldId": {
"format": "uuid",
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/GroupBySettings"
},
"type": {
"const": "field",
"type": "string"
}
},
"required": [
"fieldId",
"settings",
"type"
],
"title": "GroupByField",
"type": "object"
},
"GroupByFieldType": {
"properties": {
"fieldTypeId": {
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/GroupBySettings"
},
"type": {
"const": "fieldType",
"type": "string"
}
},
"required": [
"fieldTypeId",
"settings",
"type"
],
"title": "GroupByFieldType",
"type": "object"
},
"GroupByParent": {
"properties": {
"settings": {
"$ref": "#/components/schemas/GroupBySettings"
},
"type": {
"const": "parent",
"type": "string"
}
},
"required": [
"settings",
"type"
],
"title": "GroupByParent",
"type": "object"
},
"GroupBySettings": {
"properties": {
"direction": {
"$ref": "#/components/schemas/Direction"
},
"nonExclusive": {
"type": "boolean"
},
"showEmptyGroups": {
"type": "boolean"
},
"swimlaneMode": {
"type": "boolean"
}
},
"required": [
"direction"
],
"title": "GroupBySettings",
"type": "object"
},
"GroupByStatus": {
"properties": {
"settings": {
"$ref": "#/components/schemas/GroupBySettings"
},
"type": {
"const": "status",
"type": "string"
}
},
"required": [
"settings",
"type"
],
"title": "GroupByStatus",
"type": "object"
},
"GroupByStatusCategory": {
"properties": {
"settings": {
"$ref": "#/components/schemas/GroupBySettings"
},
"type": {
"const": "statusCategory",
"type": "string"
}
},
"required": [
"settings",
"type"
],
"title": "GroupByStatusCategory",
"type": "object"
},
"HealthCheckInHealthCheckInsConfidence": {
"enum": [
"atRisk",
"offTrack",
"onTrack"
],
"title": "HealthCheckInHealthCheckInsConfidence",
"type": "string"
},
"HealthCheckInsApp": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/HealthCheckInsAppTypeSettings"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "health-check-ins",
"type": "string"
}
},
"required": [
"id",
"teamId",
"typeId",
"settings"
],
"title": "HealthCheckInsApp",
"type": "object"
},
"HealthCheckInsAppTypeSettings": {
"properties": {
"healthCheckInsFieldId": {
"format": "uuid",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"workspaceId",
"healthCheckInsFieldId"
],
"title": "HealthCheckInsAppTypeSettings",
"type": "object"
},
"HealthCheckInsConfidenceFieldFilter": {
"discriminator": {
"mapping": {
"containsAny": "#/components/schemas/HealthCheckInsConfidenceFieldFilterContainsAny",
"defined": "#/components/schemas/HealthCheckInsConfidenceFieldFilterDefined"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/HealthCheckInsConfidenceFieldFilterContainsAny"
},
{
"$ref": "#/components/schemas/HealthCheckInsConfidenceFieldFilterDefined"
}
],
"title": "HealthCheckInsConfidenceFieldFilter"
},
"HealthCheckInsConfidenceFieldFilterContainsAny": {
"properties": {
"type": {
"const": "containsAny",
"type": "string"
},
"values": {
"items": {
"$ref": "#/components/schemas/HealthCheckInHealthCheckInsConfidence"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"values",
"type"
],
"title": "HealthCheckInsConfidenceFieldFilterContainsAny",
"type": "object"
},
"HealthCheckInsConfidenceFieldFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "HealthCheckInsConfidenceFieldFilterDefined",
"type": "object"
},
"HealthCheckInsFieldField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "health-check-ins-field",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "HealthCheckInsFieldField",
"type": "object"
},
"HealthCheckInsFieldFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "health-check-ins-field",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "HealthCheckInsFieldFieldWithFieldEmbed",
"type": "object"
},
"InboxViewCounter": {
"properties": {
"count": {
"description": "Number of items in the counter.",
"format": "int32",
"type": "integer"
},
"id": {
"description": "Machine-readable ID of the counter.",
"type": "string"
},
"name": {
"description": "Human-readable name of the counter.",
"type": "string"
}
},
"required": [
"id",
"name",
"count"
],
"title": "InboxViewCounter",
"type": "object"
},
"InboxViewCountersRequest": {
"properties": {
"archived": {
"description": "Whether archived items should be included or excluded from all the counters.",
"type": "boolean"
},
"countAssigned": {
"description": "Whether to also additionally return a counter of items with assigned users.",
"type": "boolean"
},
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"description": "Custom filter to apply to the counted items. If not specified, then the default filter from the view settings is used.",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
}
},
"required": [
"countAssigned",
"archived"
],
"title": "InboxViewCountersRequest",
"type": "object"
},
"InboxViewTypeSettings": {
"properties": {
"showAlias": {
"default": false,
"type": "boolean"
},
"showAssignees": {
"default": false,
"type": "boolean"
},
"showCreatedAt": {
"default": false,
"type": "boolean"
},
"showFieldIds": {
"default": [],
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"showFieldTypes": {
"default": [],
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"showIntegrations": {
"default": false,
"type": "boolean"
},
"showLastUpdatedAt": {
"default": false,
"type": "boolean"
},
"showParentItems": {
"default": false,
"type": "boolean"
},
"showProgress": {
"default": true,
"type": "boolean"
},
"showStatus": {
"default": true,
"type": "boolean"
},
"statusField": {
"$ref": "#/components/schemas/ViewSettingsField"
}
},
"required": [
"statusField"
],
"title": "InboxViewTypeSettings",
"type": "object"
},
"InboxViewWithViewEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/ViewEmbed"
},
"description": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isPrivate": {
"type": "boolean"
},
"itemFilter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"itemScopeLimit": {
"$ref": "#/components/schemas/ItemScopeLimit"
},
"itemSort": {
"items": {
"$ref": "#/components/schemas/ItemSearchQuerySort"
},
"type": "array"
},
"name": {
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"pinnedToPosition": {
"format": "int32",
"type": "integer"
},
"settings": {
"$ref": "#/components/schemas/InboxViewTypeSettings"
},
"typeId": {
"const": "inbox",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"typeId",
"settings",
"name",
"description",
"itemSort",
"order",
"isPrivate",
"_embedded"
],
"title": "InboxViewWithViewEmbed",
"type": "object"
},
"InputFormat": {
"default": "text",
"enum": [
"html",
"markdown",
"slack",
"text"
],
"title": "InputFormat",
"type": "string"
},
"InsightsAgentSettings": {
"default": {
"createItemWhenNoneFound": false,
"enabled": false,
"triggerOnItemCreate": false
},
"properties": {
"createItemWhenNoneFound": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"extraPrompt": {
"type": "string"
},
"triggerOnItemCreate": {
"type": "boolean"
}
},
"required": [
"enabled",
"triggerOnItemCreate",
"createItemWhenNoneFound"
],
"title": "InsightsAgentSettings",
"type": "object"
},
"InsightsApp": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/InsightsAppTypeSettings"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "insights",
"type": "string"
}
},
"required": [
"id",
"teamId",
"typeId",
"settings"
],
"title": "InsightsApp",
"type": "object"
},
"InsightsAppTypeSettings": {
"properties": {
"agentSettings": {
"$ref": "#/components/schemas/InsightsAgentSettings"
},
"fieldIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"insightsFieldId": {
"format": "uuid",
"type": "string"
},
"scoringMode": {
"$ref": "#/components/schemas/InsightsScoringMode"
},
"showStatus": {
"type": "boolean"
},
"targets": {
"items": {
"$ref": "#/components/schemas/InsightsAppTypeSettingsTarget"
},
"type": "array"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"workspaceId",
"insightsFieldId",
"targets",
"fieldIds",
"showStatus",
"scoringMode"
],
"title": "InsightsAppTypeSettings",
"type": "object"
},
"InsightsAppTypeSettingsTarget": {
"properties": {
"insightsFieldId": {
"format": "uuid",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"workspaceId",
"insightsFieldId"
],
"title": "InsightsAppTypeSettingsTarget",
"type": "object"
},
"InsightsField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/InsightsFieldTypeSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "insights",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "InsightsField",
"type": "object"
},
"InsightsFieldTypeFilter": {
"discriminator": {
"mapping": {
"contain": "#/components/schemas/InsightsFieldTypeFilterContain",
"defined": "#/components/schemas/InsightsFieldTypeFilterDefined",
"scoreEqual": "#/components/schemas/InsightsFieldTypeFilterEqual",
"scoreGreaterThan": "#/components/schemas/InsightsFieldTypeFilterGreaterThan",
"scoreGreaterThanOrEqual": "#/components/schemas/InsightsFieldTypeFilterGreaterThanOrEqual",
"scoreLessThan": "#/components/schemas/InsightsFieldTypeFilterLessThan",
"scoreLessThanOrEqual": "#/components/schemas/InsightsFieldTypeFilterLessThanOrEqual"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/InsightsFieldTypeFilterContain"
},
{
"$ref": "#/components/schemas/InsightsFieldTypeFilterDefined"
},
{
"$ref": "#/components/schemas/InsightsFieldTypeFilterEqual"
},
{
"$ref": "#/components/schemas/InsightsFieldTypeFilterGreaterThan"
},
{
"$ref": "#/components/schemas/InsightsFieldTypeFilterGreaterThanOrEqual"
},
{
"$ref": "#/components/schemas/InsightsFieldTypeFilterLessThan"
},
{
"$ref": "#/components/schemas/InsightsFieldTypeFilterLessThanOrEqual"
}
],
"title": "InsightsFieldTypeFilter"
},
"InsightsFieldTypeFilterContain": {
"properties": {
"itemId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "contain",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"itemId",
"workspaceId",
"type"
],
"title": "InsightsFieldTypeFilterContain",
"type": "object"
},
"InsightsFieldTypeFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "InsightsFieldTypeFilterDefined",
"type": "object"
},
"InsightsFieldTypeFilterEqual": {
"properties": {
"number": {
"type": "number"
},
"type": {
"const": "scoreEqual",
"type": "string"
}
},
"required": [
"number",
"type"
],
"title": "InsightsFieldTypeFilterEqual",
"type": "object"
},
"InsightsFieldTypeFilterGreaterThan": {
"properties": {
"number": {
"type": "number"
},
"type": {
"const": "scoreGreaterThan",
"type": "string"
}
},
"required": [
"number",
"type"
],
"title": "InsightsFieldTypeFilterGreaterThan",
"type": "object"
},
"InsightsFieldTypeFilterGreaterThanOrEqual": {
"properties": {
"number": {
"type": "number"
},
"type": {
"const": "scoreGreaterThanOrEqual",
"type": "string"
}
},
"required": [
"number",
"type"
],
"title": "InsightsFieldTypeFilterGreaterThanOrEqual",
"type": "object"
},
"InsightsFieldTypeFilterLessThan": {
"properties": {
"number": {
"type": "number"
},
"type": {
"const": "scoreLessThan",
"type": "string"
}
},
"required": [
"number",
"type"
],
"title": "InsightsFieldTypeFilterLessThan",
"type": "object"
},
"InsightsFieldTypeFilterLessThanOrEqual": {
"properties": {
"number": {
"type": "number"
},
"type": {
"const": "scoreLessThanOrEqual",
"type": "string"
}
},
"required": [
"number",
"type"
],
"title": "InsightsFieldTypeFilterLessThanOrEqual",
"type": "object"
},
"InsightsFieldTypeSettings": {
"properties": {
"maximum": {
"format": "int32",
"type": "integer"
}
},
"title": "InsightsFieldTypeSettings",
"type": "object"
},
"InsightsFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/InsightsFieldTypeSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "insights",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "InsightsFieldWithFieldEmbed",
"type": "object"
},
"InsightsScoringMode": {
"discriminator": {
"mapping": {
"customFormula": "#/components/schemas/InsightsScoringModeCustomFormula",
"default": "#/components/schemas/InsightsScoringModeDefault"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/InsightsScoringModeCustomFormula"
},
{
"$ref": "#/components/schemas/InsightsScoringModeDefault"
}
],
"title": "InsightsScoringMode"
},
"InsightsScoringModeCustomFormula": {
"properties": {
"scoringFormula": {
"$ref": "#/components/schemas/ScoringFormula"
},
"type": {
"const": "customFormula",
"type": "string"
}
},
"required": [
"scoringFormula",
"type"
],
"title": "InsightsScoringModeCustomFormula",
"type": "object"
},
"InsightsScoringModeDefault": {
"properties": {
"type": {
"const": "default",
"type": "string"
}
},
"required": [
"type"
],
"title": "InsightsScoringModeDefault",
"type": "object"
},
"InstallBooleanFieldRequest": {
"properties": {
"description": {
"description": "User-readable field description.",
"type": "string"
},
"isTeamField": {
"default": false,
"description": "Whether the field should be installed as a team-field or a workspace-specific field.",
"type": "boolean"
},
"name": {
"description": "User-readable field name.",
"type": "string"
},
"required": {
"type": "boolean"
},
"typeId": {
"const": "boolean",
"type": "string"
},
"workspaceIds": {
"default": [],
"description": "If isTeamField=false then exactly one workspace ID should be provided.\nIf isTeamField=true then any amount of workspace IDs can be provided to be linked to the newly installed field.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"typeId",
"name",
"description",
"required"
],
"title": "InstallBooleanFieldRequest",
"type": "object"
},
"InstallDateFieldRequest": {
"properties": {
"description": {
"description": "User-readable field description.",
"type": "string"
},
"isTeamField": {
"default": false,
"description": "Whether the field should be installed as a team-field or a workspace-specific field.",
"type": "boolean"
},
"name": {
"description": "User-readable field name.",
"type": "string"
},
"required": {
"type": "boolean"
},
"typeId": {
"const": "date",
"type": "string"
},
"workspaceIds": {
"default": [],
"description": "If isTeamField=false then exactly one workspace ID should be provided.\nIf isTeamField=true then any amount of workspace IDs can be provided to be linked to the newly installed field.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"typeId",
"name",
"description",
"required"
],
"title": "InstallDateFieldRequest",
"type": "object"
},
"InstallDateRangeFieldRequest": {
"properties": {
"description": {
"description": "User-readable field description.",
"type": "string"
},
"isTeamField": {
"default": false,
"description": "Whether the field should be installed as a team-field or a workspace-specific field.",
"type": "boolean"
},
"name": {
"description": "User-readable field name.",
"type": "string"
},
"required": {
"type": "boolean"
},
"typeId": {
"const": "date-range",
"type": "string"
},
"workspaceIds": {
"default": [],
"description": "If isTeamField=false then exactly one workspace ID should be provided.\nIf isTeamField=true then any amount of workspace IDs can be provided to be linked to the newly installed field.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"typeId",
"name",
"description",
"required"
],
"title": "InstallDateRangeFieldRequest",
"type": "object"
},
"InstallFieldRequest": {
"discriminator": {
"mapping": {
"boolean": "#/components/schemas/InstallBooleanFieldRequest",
"date": "#/components/schemas/InstallDateFieldRequest",
"date-range": "#/components/schemas/InstallDateRangeFieldRequest",
"milestone": "#/components/schemas/InstallMilestoneFieldRequest",
"number": "#/components/schemas/InstallNumberFieldRequest",
"people": "#/components/schemas/InstallPeopleFieldRequest",
"select": "#/components/schemas/InstallSelectFieldRequest",
"text": "#/components/schemas/InstallTextFieldRequest",
"time-period": "#/components/schemas/InstallTimePeriodFieldRequest"
},
"propertyName": "typeId"
},
"oneOf": [
{
"$ref": "#/components/schemas/InstallBooleanFieldRequest"
},
{
"$ref": "#/components/schemas/InstallDateFieldRequest"
},
{
"$ref": "#/components/schemas/InstallDateRangeFieldRequest"
},
{
"$ref": "#/components/schemas/InstallMilestoneFieldRequest"
},
{
"$ref": "#/components/schemas/InstallNumberFieldRequest"
},
{
"$ref": "#/components/schemas/InstallPeopleFieldRequest"
},
{
"$ref": "#/components/schemas/InstallSelectFieldRequest"
},
{
"$ref": "#/components/schemas/InstallTextFieldRequest"
},
{
"$ref": "#/components/schemas/InstallTimePeriodFieldRequest"
}
],
"title": "InstallFieldRequest"
},
"InstallMilestoneFieldRequest": {
"properties": {
"description": {
"description": "User-readable field description.",
"type": "string"
},
"isTeamField": {
"default": false,
"description": "Whether the field should be installed as a team-field or a workspace-specific field.",
"type": "boolean"
},
"name": {
"description": "User-readable field name.",
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/MilestoneFieldTypeSettings",
"description": "Field settings."
},
"typeId": {
"const": "milestone",
"type": "string"
},
"workspaceIds": {
"default": [],
"description": "If isTeamField=false then exactly one workspace ID should be provided.\nIf isTeamField=true then any amount of workspace IDs can be provided to be linked to the newly installed field.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"typeId",
"name",
"description",
"settings",
"required"
],
"title": "InstallMilestoneFieldRequest",
"type": "object"
},
"InstallNumberFieldRequest": {
"properties": {
"description": {
"description": "User-readable field description.",
"type": "string"
},
"isTeamField": {
"default": false,
"description": "Whether the field should be installed as a team-field or a workspace-specific field.",
"type": "boolean"
},
"name": {
"description": "User-readable field name.",
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/NumberFieldTypeSettings",
"description": "Field settings."
},
"typeId": {
"const": "number",
"type": "string"
},
"workspaceIds": {
"default": [],
"description": "If isTeamField=false then exactly one workspace ID should be provided.\nIf isTeamField=true then any amount of workspace IDs can be provided to be linked to the newly installed field.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"typeId",
"name",
"description",
"settings",
"required"
],
"title": "InstallNumberFieldRequest",
"type": "object"
},
"InstallPeopleFieldRequest": {
"properties": {
"description": {
"description": "User-readable field description.",
"type": "string"
},
"isTeamField": {
"default": false,
"description": "Whether the field should be installed as a team-field or a workspace-specific field.",
"type": "boolean"
},
"name": {
"description": "User-readable field name.",
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/PeopleFieldTypeSettings",
"description": "Field settings."
},
"typeId": {
"const": "people",
"type": "string"
},
"workspaceIds": {
"default": [],
"description": "If isTeamField=false then exactly one workspace ID should be provided.\nIf isTeamField=true then any amount of workspace IDs can be provided to be linked to the newly installed field.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"typeId",
"name",
"description",
"settings",
"required"
],
"title": "InstallPeopleFieldRequest",
"type": "object"
},
"InstallSelectFieldRequest": {
"properties": {
"description": {
"description": "User-readable field description.",
"type": "string"
},
"isTeamField": {
"default": false,
"description": "Whether the field should be installed as a team-field or a workspace-specific field.",
"type": "boolean"
},
"name": {
"description": "User-readable field name.",
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/SelectFieldTypeSettings",
"description": "Field settings."
},
"typeId": {
"const": "select",
"type": "string"
},
"workspaceIds": {
"default": [],
"description": "If isTeamField=false then exactly one workspace ID should be provided.\nIf isTeamField=true then any amount of workspace IDs can be provided to be linked to the newly installed field.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"typeId",
"name",
"description",
"settings",
"required"
],
"title": "InstallSelectFieldRequest",
"type": "object"
},
"InstallTextFieldRequest": {
"properties": {
"description": {
"description": "User-readable field description.",
"type": "string"
},
"isTeamField": {
"default": false,
"description": "Whether the field should be installed as a team-field or a workspace-specific field.",
"type": "boolean"
},
"name": {
"description": "User-readable field name.",
"type": "string"
},
"required": {
"type": "boolean"
},
"typeId": {
"const": "text",
"type": "string"
},
"workspaceIds": {
"default": [],
"description": "If isTeamField=false then exactly one workspace ID should be provided.\nIf isTeamField=true then any amount of workspace IDs can be provided to be linked to the newly installed field.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"typeId",
"name",
"description",
"required"
],
"title": "InstallTextFieldRequest",
"type": "object"
},
"InstallTimePeriodFieldRequest": {
"properties": {
"description": {
"description": "User-readable field description.",
"type": "string"
},
"isTeamField": {
"default": false,
"description": "Whether the field should be installed as a team-field or a workspace-specific field.",
"type": "boolean"
},
"name": {
"description": "User-readable field name.",
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/TimePeriodFieldSettings",
"description": "Field settings."
},
"typeId": {
"const": "time-period",
"type": "string"
},
"workspaceIds": {
"default": [],
"description": "If isTeamField=false then exactly one workspace ID should be provided.\nIf isTeamField=true then any amount of workspace IDs can be provided to be linked to the newly installed field.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"typeId",
"name",
"description",
"settings",
"required"
],
"title": "InstallTimePeriodFieldRequest",
"type": "object"
},
"IntegrationAuthorizationCodeChallenge": {
"properties": {
"challenge": {
"type": "string"
},
"method": {
"$ref": "#/components/schemas/IntegrationAuthorizationCodeChallengeMethod"
}
},
"required": [
"challenge",
"method"
],
"title": "IntegrationAuthorizationCodeChallenge",
"type": "object"
},
"IntegrationAuthorizationCodeChallengeMethod": {
"enum": [
"plain",
"S256"
],
"title": "IntegrationAuthorizationCodeChallengeMethod",
"type": "string"
},
"IntegrationCapabilities": {
"properties": {
"debug": {
"type": "boolean"
},
"hierarchy": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"sync": {
"type": "boolean"
}
},
"required": [
"sync",
"push",
"hierarchy",
"debug"
],
"title": "IntegrationCapabilities",
"type": "object"
},
"IntegrationClientConnectionSettings": {
"properties": {
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"codeChallenge": {
"$ref": "#/components/schemas/IntegrationAuthorizationCodeChallenge"
},
"tokenIntrospectionUri": {
"type": "string"
}
},
"required": [
"clientId",
"clientSecret"
],
"title": "IntegrationClientConnectionSettings",
"type": "object"
},
"IntegrationSecrets": {
"properties": {
"accessToken": {
"type": "string"
},
"accessTokenExpiresAt": {
"format": "date-time",
"type": "string"
},
"refreshToken": {
"type": "string"
}
},
"required": [
"accessToken"
],
"title": "IntegrationSecrets",
"type": "object"
},
"IntegrationSslConfiguration": {
"properties": {
"clientAuthentication": {
"$ref": "#/components/schemas/IntegrationSslConfigurationClientAuthentication"
},
"trustedCertificates": {
"type": "string"
}
},
"title": "IntegrationSslConfiguration",
"type": "object"
},
"IntegrationSslConfigurationClientAuthentication": {
"properties": {
"certificate": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"certificate",
"key"
],
"title": "IntegrationSslConfigurationClientAuthentication",
"type": "object"
},
"IntegrationSummary": {
"discriminator": {
"mapping": {
"asana": "#/components/schemas/AsanaIntegrationSummary",
"azure-devops": "#/components/schemas/AzureDevopsIntegrationSummary",
"clubhouse": "#/components/schemas/ClubhouseIntegrationSummary",
"github": "#/components/schemas/GithubIntegrationSummary",
"intercom": "#/components/schemas/IntercomIntegrationSummary",
"jira": "#/components/schemas/JiraIntegrationSummary",
"linear": "#/components/schemas/LinearIntegrationSummary",
"planner": "#/components/schemas/PlannerIntegrationSummary",
"salesforce": "#/components/schemas/SalesforceIntegrationSummary",
"trello": "#/components/schemas/TrelloIntegrationSummary",
"webhook": "#/components/schemas/WebhookIntegrationSummary",
"zendesk": "#/components/schemas/ZendeskIntegrationSummary"
},
"propertyName": "typeId"
},
"oneOf": [
{
"$ref": "#/components/schemas/AsanaIntegrationSummary"
},
{
"$ref": "#/components/schemas/AzureDevopsIntegrationSummary"
},
{
"$ref": "#/components/schemas/ClubhouseIntegrationSummary"
},
{
"$ref": "#/components/schemas/GithubIntegrationSummary"
},
{
"$ref": "#/components/schemas/IntercomIntegrationSummary"
},
{
"$ref": "#/components/schemas/JiraIntegrationSummary"
},
{
"$ref": "#/components/schemas/LinearIntegrationSummary"
},
{
"$ref": "#/components/schemas/PlannerIntegrationSummary"
},
{
"$ref": "#/components/schemas/SalesforceIntegrationSummary"
},
{
"$ref": "#/components/schemas/TrelloIntegrationSummary"
},
{
"$ref": "#/components/schemas/WebhookIntegrationSummary"
},
{
"$ref": "#/components/schemas/ZendeskIntegrationSummary"
}
],
"title": "IntegrationSummary"
},
"IntegrationSyncState": {
"properties": {
"errorCount": {
"format": "int32",
"type": "integer"
},
"failedRunsCount": {
"format": "int32",
"type": "integer"
},
"successCount": {
"format": "int32",
"type": "integer"
},
"totalRunsCount": {
"format": "int32",
"type": "integer"
}
},
"required": [
"successCount",
"errorCount",
"totalRunsCount",
"failedRunsCount"
],
"title": "IntegrationSyncState",
"type": "object"
},
"IntercomIntegrationSummary": {
"properties": {
"capabilities": {
"$ref": "#/components/schemas/IntegrationCapabilities"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"lastSyncAt": {
"format": "date-time",
"type": "string"
},
"lastSyncState": {
"$ref": "#/components/schemas/IntegrationSyncState"
},
"settings": {
"$ref": "#/components/schemas/IntercomIntegrationTypeSettings"
},
"typeId": {
"const": "intercom",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"createdAt",
"capabilities",
"enabled"
],
"title": "IntercomIntegrationSummary",
"type": "object"
},
"IntercomIntegrationTypeSettings": {
"properties": {
"accessToken": {
"type": "string"
},
"authorFormat": {
"$ref": "#/components/schemas/AuthorFormatLevel"
},
"autoSync": {
"type": "boolean"
},
"importFrom": {
"format": "date",
"type": "string"
},
"mapping": {
"items": {
"$ref": "#/components/schemas/IntercomIntegrationTypeSettingsMapping"
},
"type": "array",
"uniqueItems": true
},
"mappings": {
"default": [],
"items": {
"$ref": "#/components/schemas/MappingSettingsIntegrationMappingSettings"
},
"type": "array"
},
"removeExtraneous": {
"type": "boolean"
},
"selectTags": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"summarizeTitle": {
"type": "boolean"
},
"title": {
"type": "string"
}
},
"required": [
"autoSync",
"removeExtraneous",
"summarizeTitle"
],
"title": "IntercomIntegrationTypeSettings",
"type": "object"
},
"IntercomIntegrationTypeSettingsMapping": {
"properties": {
"fieldId": {
"format": "uuid",
"type": "string"
},
"intercomFieldId": {
"type": "string"
}
},
"required": [
"intercomFieldId",
"fieldId"
],
"title": "IntercomIntegrationTypeSettingsMapping",
"type": "object"
},
"InviteUserRequest": {
"properties": {
"email": {
"type": "string"
},
"fullName": {
"type": "string"
},
"role": {
"$ref": "#/components/schemas/Role"
}
},
"required": [
"email",
"role",
"fullName"
],
"title": "InviteUserRequest",
"type": "object"
},
"Item": {
"properties": {
"archived": {
"description": "Whether this item is archived.",
"type": "boolean"
},
"assigneeUserGroupIds": {
"description": "Ids of user groups that are assigned to this item.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"assigneeUserIds": {
"description": "Ids of users who are assigned to this item.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"color": {
"$ref": "#/components/schemas/ItemColor",
"description": "Color of this item."
},
"createdAt": {
"description": "Timestamp of when this item was created.",
"format": "date-time",
"type": "string"
},
"description": {
"$ref": "#/components/schemas/RichText",
"description": "Rich text content as structured blocks. Different media types provide markdown support:\n• application/json - Default blocks format\n• application/vnd.airfocus.markdown+json - All RichText fields become markdown strings (recommended)\n• application/json+markdown - Legacy format, only top-level fields converted to markdown"
},
"fields": {
"additionalProperties": {},
"description": "Values of custom fields, where each key is a custom-field ID and each value is a JSON-formatted value of the corresponding field.",
"examples": [
{
"0fc3cfbc-27e9-3ea6-8a78-7de13dae3e3c": {
"number": 42
},
"34f05b62-dd43-3e1e-82bc-b0acabd0d004": {
"boolean": true
},
"5396681e-ea50-3d63-9ae3-c9f8ca17b7d8": {
"userGroupIds": [
"70e2b87a-b774-3022-9ef0-e55031a1c4fb"
],
"userIds": [
"24c9e15e-52af-347c-a25b-757e7bee1f9d"
]
},
"75fe57ec-4a04-3a30-8cac-5f27223df81a": {
"dateRange": {
"endDate": "2024-02-14",
"startDate": "2024-01-14",
"timezone": "UTC"
}
},
"8be74552-df93-331b-bdd6-b36ed74bdb6a": {
"selection": [
"2bb225ce-b5ee-3493-967c-fde0d72da242"
]
},
"c7824f3d-4d5f-3b2f-a2d0-34758c1e9454": {
"text": "A platform built for the new way of doing product management"
},
"e34d514f-7db5-38aa-872a-7c8191a09617": {
"date": {
"date": "2024-01-01",
"timezone": "UTC"
}
}
}
],
"type": "object"
},
"id": {
"description": "Unique identifier of this item.",
"format": "uuid",
"type": "string"
},
"lastUpdatedAt": {
"description": "Timestamp of when this item was last updated.",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name (title) of this item.",
"type": "string"
},
"number": {
"description": "A numeric id of this item, which is used to create an alias to this item like DEV-123. The number is unique within the workspace, and defined by server on item creation.",
"format": "int32",
"type": "integer"
},
"order": {
"description": "A order number of this item for sorting.",
"format": "int32",
"type": "integer"
},
"statusCategoryUpdatedAt": {
"description": "Timestamp of when the status of this item was last time switched from one category to another.",
"format": "date-time",
"type": "string"
},
"statusId": {
"description": "Id of the status of this item.",
"format": "uuid",
"type": "string"
},
"statusUpdatedAt": {
"description": "Timestamp of when the status of this item was last updated.",
"format": "date-time",
"type": "string"
},
"workspaceId": {
"description": "Id of the workspace this workspace belongs to.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"statusId",
"color",
"name",
"description",
"assigneeUserIds",
"assigneeUserGroupIds",
"fields",
"archived",
"createdAt",
"lastUpdatedAt",
"order"
],
"title": "Item",
"type": "object"
},
"ItemAttachmentBulkAction": {
"discriminator": {
"mapping": {
"create": "#/components/schemas/ItemAttachmentBulkCreate",
"delete": "#/components/schemas/ItemAttachmentBulkDelete",
"patch": "#/components/schemas/ItemAttachmentBulkPatch",
"update": "#/components/schemas/ItemAttachmentBulkUpdate"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ItemAttachmentBulkCreate"
},
{
"$ref": "#/components/schemas/ItemAttachmentBulkDelete"
},
{
"$ref": "#/components/schemas/ItemAttachmentBulkPatch"
},
{
"$ref": "#/components/schemas/ItemAttachmentBulkUpdate"
}
],
"title": "ItemAttachmentBulkAction"
},
"ItemAttachmentBulkCreate": {
"properties": {
"resource": {
"$ref": "#/components/schemas/CreateItemAttachmentRequest"
},
"type": {
"enum": [
"create"
],
"type": "string"
}
},
"required": [
"resource",
"type"
],
"title": "ItemAttachmentBulkCreate",
"type": "object"
},
"ItemAttachmentBulkDelete": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"type": {
"enum": [
"delete"
],
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "ItemAttachmentBulkDelete",
"type": "object"
},
"ItemAttachmentBulkPatch": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"transform": {
"$ref": "#/components/schemas/JsonPatch"
},
"type": {
"enum": [
"patch"
],
"type": "string"
}
},
"required": [
"id",
"transform",
"type"
],
"title": "ItemAttachmentBulkPatch",
"type": "object"
},
"ItemAttachmentBulkUpdate": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/UpdateItemAttachmentRequest"
},
"type": {
"enum": [
"update"
],
"type": "string"
}
},
"required": [
"id",
"resource",
"type"
],
"title": "ItemAttachmentBulkUpdate",
"type": "object"
},
"ItemAttachmentWithEmbed": {
"description": "A connection link between an item and an uploaded attachment.",
"properties": {
"_embedded": {
"type": "object"
},
"contentType": {
"description": "Type of updated content.",
"type": "string"
},
"createdAt": {
"description": "When this attachment link has been created.",
"format": "date-time",
"type": "string"
},
"id": {
"description": "ID of an item-attachment link.",
"format": "uuid",
"type": "string"
},
"itemId": {
"description": "ID of the item to which the attachment is linked.",
"format": "uuid",
"type": "string"
},
"lastUpdatedAt": {
"description": "When this attachment link has been updated for the last time.",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of the attachment, e.g. its file name (to be displayed in UI).",
"type": "string"
},
"uri": {
"description": "URI of the attachment contents. It can be any URI, but conventionally it's a relative URI like 'attachment:1ecb9ecd-8a97-403a-a74a-741eb4b8fb69' with UUID of a file uploaded to airfocus file-storage. Such URI is then resolved by clients into a full HTTPS URL.",
"type": "string"
}
},
"required": [
"id",
"itemId",
"name",
"uri",
"contentType",
"createdAt",
"lastUpdatedAt",
"_embedded"
],
"title": "ItemAttachmentWithEmbed",
"type": "object"
},
"ItemAttachmentWithEmbedOrNullList": {
"items": {
"$ref": "#/components/schemas/ItemAttachmentWithEmbed"
},
"title": "ItemAttachmentWithEmbedOrNullList",
"type": "array"
},
"ItemAttachmentWithEmbedPage": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ItemAttachmentWithEmbed"
},
"type": "array"
},
"totalItems": {
"format": "int32",
"type": "integer"
}
},
"required": [
"items",
"totalItems"
],
"title": "ItemAttachmentWithEmbedPage",
"type": "object"
},
"ItemBulkAction": {
"discriminator": {
"mapping": {
"create": "#/components/schemas/ItemBulkCreate",
"delete": "#/components/schemas/ItemBulkDelete",
"patch": "#/components/schemas/ItemBulkPatch",
"update": "#/components/schemas/ItemBulkUpdate"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ItemBulkCreate"
},
{
"$ref": "#/components/schemas/ItemBulkDelete"
},
{
"$ref": "#/components/schemas/ItemBulkPatch"
},
{
"$ref": "#/components/schemas/ItemBulkUpdate"
}
],
"title": "ItemBulkAction"
},
"ItemBulkCreate": {
"properties": {
"resource": {
"$ref": "#/components/schemas/CreateItemRequest"
},
"type": {
"enum": [
"create"
],
"type": "string"
}
},
"required": [
"resource",
"type"
],
"title": "ItemBulkCreate",
"type": "object"
},
"ItemBulkDelete": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"type": {
"enum": [
"delete"
],
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "ItemBulkDelete",
"type": "object"
},
"ItemBulkPatch": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"transform": {
"$ref": "#/components/schemas/JsonPatch"
},
"type": {
"enum": [
"patch"
],
"type": "string"
}
},
"required": [
"id",
"transform",
"type"
],
"title": "ItemBulkPatch",
"type": "object"
},
"ItemBulkUpdate": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/UpdateItemRequest"
},
"type": {
"enum": [
"update"
],
"type": "string"
}
},
"required": [
"id",
"resource",
"type"
],
"title": "ItemBulkUpdate",
"type": "object"
},
"ItemColor": {
"enum": [
"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"
],
"title": "ItemColor",
"type": "string"
},
"ItemCommentCreateRequest": {
"properties": {
"content": {
"$ref": "#/components/schemas/RichText",
"description": "Rich text content as structured blocks. Different media types provide markdown support:\n• application/json - Default blocks format\n• application/vnd.airfocus.markdown+json - All RichText fields become markdown strings (recommended)\n• application/json+markdown - Legacy format, only top-level fields converted to markdown"
},
"itemId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"itemId",
"content"
],
"title": "ItemCommentCreateRequest",
"type": "object"
},
"ItemCommentEmbed": {
"title": "ItemCommentEmbed",
"type": "object"
},
"ItemCommentReaction": {
"properties": {
"emoji": {
"$ref": "#/components/schemas/Emoji"
},
"userIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"emoji",
"userIds"
],
"title": "ItemCommentReaction",
"type": "object"
},
"ItemCommentSearchQuery": {
"properties": {
"itemId": {
"format": "uuid",
"type": "string"
}
},
"title": "ItemCommentSearchQuery",
"type": "object"
},
"ItemCommentUpdateRequest": {
"properties": {
"content": {
"$ref": "#/components/schemas/RichText",
"description": "Rich text content as structured blocks. Different media types provide markdown support:\n• application/json - Default blocks format\n• application/vnd.airfocus.markdown+json - All RichText fields become markdown strings (recommended)\n• application/json+markdown - Legacy format, only top-level fields converted to markdown"
}
},
"required": [
"content"
],
"title": "ItemCommentUpdateRequest",
"type": "object"
},
"ItemCommentWithItemCommentEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/ItemCommentEmbed"
},
"content": {
"$ref": "#/components/schemas/RichText",
"description": "Rich text content as structured blocks. Different media types provide markdown support:\n• application/json - Default blocks format\n• application/vnd.airfocus.markdown+json - All RichText fields become markdown strings (recommended)\n• application/json+markdown - Legacy format, only top-level fields converted to markdown"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"initiator": {
"$ref": "#/components/schemas/Actor"
},
"itemId": {
"format": "uuid",
"type": "string"
},
"lastUpdatedAt": {
"format": "date-time",
"type": "string"
},
"reactions": {
"items": {
"$ref": "#/components/schemas/ItemCommentReaction"
},
"type": "array"
}
},
"required": [
"id",
"itemId",
"initiator",
"content",
"reactions",
"createdAt",
"lastUpdatedAt",
"_embedded"
],
"title": "ItemCommentWithItemCommentEmbed",
"type": "object"
},
"ItemCommentWithItemCommentEmbedOrNullList": {
"items": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbed"
},
"title": "ItemCommentWithItemCommentEmbedOrNullList",
"type": "array"
},
"ItemCommentWithItemCommentEmbedPage": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbed"
},
"type": "array"
},
"totalItems": {
"format": "int32",
"type": "integer"
}
},
"required": [
"items",
"totalItems"
],
"title": "ItemCommentWithItemCommentEmbedPage",
"type": "object"
},
"ItemConstraint": {
"discriminator": {
"mapping": {
"integrationPushForbidden": "#/components/schemas/ItemConstraintIntegrationPushForbidden",
"integrationToInternal": "#/components/schemas/ItemConstraintIntegrationToInternal",
"propertyReadOnly": "#/components/schemas/ItemConstraintPropertyReadOnly",
"undeletable": "#/components/schemas/ItemConstraintUndeletable"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ItemConstraintIntegrationPushForbidden"
},
{
"$ref": "#/components/schemas/ItemConstraintIntegrationToInternal"
},
{
"$ref": "#/components/schemas/ItemConstraintPropertyReadOnly"
},
{
"$ref": "#/components/schemas/ItemConstraintUndeletable"
}
],
"title": "ItemConstraint"
},
"ItemConstraintIntegrationPushForbidden": {
"properties": {
"extensionId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "integrationPushForbidden",
"type": "string"
}
},
"required": [
"extensionId",
"type"
],
"title": "ItemConstraintIntegrationPushForbidden",
"type": "object"
},
"ItemConstraintIntegrationToInternal": {
"properties": {
"extensionId": {
"format": "uuid",
"type": "string"
},
"property": {
"$ref": "#/components/schemas/RefItemProperty"
},
"type": {
"const": "integrationToInternal",
"type": "string"
}
},
"required": [
"extensionId",
"property",
"type"
],
"title": "ItemConstraintIntegrationToInternal",
"type": "object"
},
"ItemConstraintPropertyReadOnly": {
"properties": {
"extensionId": {
"format": "uuid",
"type": "string"
},
"property": {
"$ref": "#/components/schemas/RefItemProperty"
},
"type": {
"const": "propertyReadOnly",
"type": "string"
}
},
"required": [
"extensionId",
"property",
"type"
],
"title": "ItemConstraintPropertyReadOnly",
"type": "object"
},
"ItemConstraintUndeletable": {
"properties": {
"extensionId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "undeletable",
"type": "string"
}
},
"required": [
"extensionId",
"type"
],
"title": "ItemConstraintUndeletable",
"type": "object"
},
"ItemEmbed": {
"properties": {
"alias": {
"type": "string"
},
"apps": {
"additionalProperties": {
"$ref": "#/components/schemas/ItemEmbedApp"
},
"type": "object"
},
"attachmentCount": {
"format": "int32",
"type": "integer"
},
"children": {
"items": {
"$ref": "#/components/schemas/RelativeItemInfo"
},
"type": "array"
},
"commentCount": {
"format": "int32",
"type": "integer"
},
"constraints": {
"items": {
"$ref": "#/components/schemas/ItemConstraint"
},
"type": "array"
},
"integration": {
"$ref": "#/components/schemas/ItemEmbedIntegration"
},
"linkCount": {
"format": "int32",
"type": "integer"
},
"parents": {
"items": {
"$ref": "#/components/schemas/RelativeItemInfo"
},
"type": "array"
},
"progress": {
"$ref": "#/components/schemas/ItemEmbedProgress"
},
"watched": {
"type": "boolean"
},
"workspaceItemType": {
"$ref": "#/components/schemas/ItemType"
}
},
"required": [
"parents",
"children",
"progress",
"apps",
"constraints",
"watched",
"linkCount",
"commentCount",
"attachmentCount"
],
"title": "ItemEmbed",
"type": "object"
},
"ItemEmbedApp": {
"properties": {
"data": {},
"id": {
"format": "uuid",
"type": "string"
},
"typeId": {
"type": "string"
}
},
"required": [
"id",
"typeId",
"data"
],
"title": "ItemEmbedApp",
"type": "object"
},
"ItemEmbedIntegration": {
"properties": {
"data": {},
"id": {
"format": "uuid",
"type": "string"
},
"typeId": {
"type": "string"
}
},
"required": [
"id",
"typeId",
"data"
],
"title": "ItemEmbedIntegration",
"type": "object"
},
"ItemEmbedProgress": {
"properties": {
"closed": {
"format": "int32",
"type": "integer"
},
"total": {
"format": "int32",
"type": "integer"
}
},
"required": [
"closed",
"total"
],
"title": "ItemEmbedProgress",
"type": "object"
},
"ItemLinkBulkAction": {
"discriminator": {
"mapping": {
"create": "#/components/schemas/ItemLinkBulkCreate",
"delete": "#/components/schemas/ItemLinkBulkDelete",
"patch": "#/components/schemas/ItemLinkBulkPatch",
"update": "#/components/schemas/ItemLinkBulkUpdate"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ItemLinkBulkCreate"
},
{
"$ref": "#/components/schemas/ItemLinkBulkDelete"
},
{
"$ref": "#/components/schemas/ItemLinkBulkPatch"
},
{
"$ref": "#/components/schemas/ItemLinkBulkUpdate"
}
],
"title": "ItemLinkBulkAction"
},
"ItemLinkBulkCreate": {
"properties": {
"resource": {
"$ref": "#/components/schemas/CreateItemLinkRequest"
},
"type": {
"enum": [
"create"
],
"type": "string"
}
},
"required": [
"resource",
"type"
],
"title": "ItemLinkBulkCreate",
"type": "object"
},
"ItemLinkBulkDelete": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"type": {
"enum": [
"delete"
],
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "ItemLinkBulkDelete",
"type": "object"
},
"ItemLinkBulkPatch": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"transform": {
"$ref": "#/components/schemas/JsonPatch"
},
"type": {
"enum": [
"patch"
],
"type": "string"
}
},
"required": [
"id",
"transform",
"type"
],
"title": "ItemLinkBulkPatch",
"type": "object"
},
"ItemLinkBulkUpdate": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/UpdateItemLinkRequest"
},
"type": {
"enum": [
"update"
],
"type": "string"
}
},
"required": [
"id",
"resource",
"type"
],
"title": "ItemLinkBulkUpdate",
"type": "object"
},
"ItemLinkConstraint": {
"discriminator": {
"mapping": {
"readonly": "#/components/schemas/ItemLinkConstraintReadonly",
"undeletable": "#/components/schemas/ItemLinkConstraintUndeletable"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ItemLinkConstraintReadonly"
},
{
"$ref": "#/components/schemas/ItemLinkConstraintUndeletable"
}
],
"title": "ItemLinkConstraint"
},
"ItemLinkConstraintReadonly": {
"properties": {
"extensionId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "readonly",
"type": "string"
}
},
"required": [
"extensionId",
"type"
],
"title": "ItemLinkConstraintReadonly",
"type": "object"
},
"ItemLinkConstraintUndeletable": {
"properties": {
"extensionId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "undeletable",
"type": "string"
}
},
"required": [
"extensionId",
"type"
],
"title": "ItemLinkConstraintUndeletable",
"type": "object"
},
"ItemLinkEmbed": {
"properties": {
"apps": {
"additionalProperties": {
"$ref": "#/components/schemas/ItemLinkEmbedApp"
},
"type": "object"
},
"constraints": {
"items": {
"$ref": "#/components/schemas/ItemLinkConstraint"
},
"type": "array"
},
"fromWorkspaceId": {
"format": "uuid",
"type": "string"
},
"toWorkspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"fromWorkspaceId",
"toWorkspaceId",
"apps",
"constraints"
],
"title": "ItemLinkEmbed",
"type": "object"
},
"ItemLinkEmbedApp": {
"properties": {
"data": {},
"id": {
"format": "uuid",
"type": "string"
},
"typeId": {
"type": "string"
}
},
"required": [
"id",
"typeId",
"data"
],
"title": "ItemLinkEmbedApp",
"type": "object"
},
"ItemLinkSearchQuery": {
"description": "Query-parameters for searching item-links.",
"properties": {
"includeArchived": {
"default": false,
"description": "Also include item-links which connect archived items.",
"type": "boolean"
},
"itemIds": {
"default": [],
"description": "Return only those item-links which connect the specified items.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"workspaceIds": {
"default": [],
"description": "Return only those item-links which connect items in the specified workspaces.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"title": "ItemLinkSearchQuery",
"type": "object"
},
"ItemLinkTypeBulkAction": {
"discriminator": {
"mapping": {
"create": "#/components/schemas/ItemLinkTypeBulkCreate",
"delete": "#/components/schemas/ItemLinkTypeBulkDelete",
"patch": "#/components/schemas/ItemLinkTypeBulkPatch",
"update": "#/components/schemas/ItemLinkTypeBulkUpdate"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ItemLinkTypeBulkCreate"
},
{
"$ref": "#/components/schemas/ItemLinkTypeBulkDelete"
},
{
"$ref": "#/components/schemas/ItemLinkTypeBulkPatch"
},
{
"$ref": "#/components/schemas/ItemLinkTypeBulkUpdate"
}
],
"title": "ItemLinkTypeBulkAction"
},
"ItemLinkTypeBulkCreate": {
"properties": {
"resource": {
"$ref": "#/components/schemas/CreateItemLinkTypeRequest"
},
"type": {
"enum": [
"create"
],
"type": "string"
}
},
"required": [
"resource",
"type"
],
"title": "ItemLinkTypeBulkCreate",
"type": "object"
},
"ItemLinkTypeBulkDelete": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"type": {
"enum": [
"delete"
],
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "ItemLinkTypeBulkDelete",
"type": "object"
},
"ItemLinkTypeBulkPatch": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"transform": {
"$ref": "#/components/schemas/JsonPatch"
},
"type": {
"enum": [
"patch"
],
"type": "string"
}
},
"required": [
"id",
"transform",
"type"
],
"title": "ItemLinkTypeBulkPatch",
"type": "object"
},
"ItemLinkTypeBulkUpdate": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/UpdateItemLinkTypeRequest"
},
"type": {
"enum": [
"update"
],
"type": "string"
}
},
"required": [
"id",
"resource",
"type"
],
"title": "ItemLinkTypeBulkUpdate",
"type": "object"
},
"ItemLinkTypeRecordEmbed": {
"title": "ItemLinkTypeRecordEmbed",
"type": "object"
},
"ItemLinkTypeRecordWithItemLinkTypeRecordEmbed": {
"description": "Custom item link type that defines how items can be related in both directions",
"properties": {
"_embedded": {
"$ref": "#/components/schemas/ItemLinkTypeRecordEmbed"
},
"backwardsName": {
"description": "The name of the link type used in the backward direction (\"{to} {backwards_name} {from}\"), e.g., \"is blocked by\" in \"B-34 is blocked by A-12\". Must contain at least one letter or digit.",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"description": "The name of the link type used in the forward direction (\"{from} {name} {to}\"), e.g., \"blocks\" in \"A-12 blocks B-34\". Must contain at least one letter or digit.",
"type": "string"
},
"teamId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"teamId",
"name",
"backwardsName",
"_embedded"
],
"title": "ItemLinkTypeRecordWithItemLinkTypeRecordEmbed",
"type": "object"
},
"ItemLinkTypeRecordWithItemLinkTypeRecordEmbedOrNullList": {
"items": {
"$ref": "#/components/schemas/ItemLinkTypeRecordWithItemLinkTypeRecordEmbed"
},
"title": "ItemLinkTypeRecordWithItemLinkTypeRecordEmbedOrNullList",
"type": "array"
},
"ItemLinkTypeRecordWithItemLinkTypeRecordEmbedPage": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ItemLinkTypeRecordWithItemLinkTypeRecordEmbed"
},
"type": "array"
},
"totalItems": {
"format": "int32",
"type": "integer"
}
},
"required": [
"items",
"totalItems"
],
"title": "ItemLinkTypeRecordWithItemLinkTypeRecordEmbedPage",
"type": "object"
},
"ItemLinkTypeSearchQuery": {
"properties": {
"nameFilter": {
"type": "string"
}
},
"title": "ItemLinkTypeSearchQuery",
"type": "object"
},
"ItemLinkTypeWorkspaceCount": {
"properties": {
"workspaceCount": {
"format": "int32",
"type": "integer"
}
},
"required": [
"workspaceCount"
],
"title": "ItemLinkTypeWorkspaceCount",
"type": "object"
},
"ItemLinkWithItemLinkEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/ItemLinkEmbed"
},
"fromItemId": {
"format": "uuid",
"type": "string"
},
"fromOrder": {
"description": "How this item-link is ordered in the list of links of the \"fromItem\".",
"format": "int32",
"type": "integer"
},
"id": {
"format": "uuid",
"type": "string"
},
"toItemId": {
"format": "uuid",
"type": "string"
},
"toOrder": {
"description": "How this item-link is ordered in the list of links of the \"toItem\".",
"format": "int32",
"type": "integer"
},
"typeId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"fromItemId",
"toItemId",
"typeId",
"fromOrder",
"toOrder",
"_embedded"
],
"title": "ItemLinkWithItemLinkEmbed",
"type": "object"
},
"ItemLinkWithItemLinkEmbedOrNullList": {
"items": {
"$ref": "#/components/schemas/ItemLinkWithItemLinkEmbed"
},
"title": "ItemLinkWithItemLinkEmbedOrNullList",
"type": "array"
},
"ItemLinkWithItemLinkEmbedPage": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ItemLinkWithItemLinkEmbed"
},
"type": "array"
},
"totalItems": {
"format": "int32",
"type": "integer"
}
},
"required": [
"items",
"totalItems"
],
"title": "ItemLinkWithItemLinkEmbedPage",
"type": "object"
},
"ItemListWidget": {
"properties": {
"dataSettings": {
"$ref": "#/components/schemas/ItemListWidgetDataSettings"
},
"displaySettings": {
"$ref": "#/components/schemas/ItemListWidgetDisplaySettings"
},
"id": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"const": "itemList",
"type": "string"
}
},
"required": [
"id",
"title",
"dataSettings",
"displaySettings",
"type"
],
"title": "ItemListWidget",
"type": "object"
},
"ItemListWidgetDataSettings": {
"properties": {
"fields": {
"items": {
"oneOf": [
{
"pattern": "fieldType:.*",
"type": "string"
},
{
"pattern": "property:.*",
"type": "string"
}
]
},
"type": "array"
},
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"period": {
"$ref": "#/components/schemas/WidgetPeriod"
},
"sortBy": {
"$ref": "#/components/schemas/ItemSearchQuerySort"
}
},
"required": [
"fields"
],
"title": "ItemListWidgetDataSettings",
"type": "object"
},
"ItemListWidgetDisplaySettings": {
"properties": {
"showTotal": {
"type": "boolean"
}
},
"required": [
"showTotal"
],
"title": "ItemListWidgetDisplaySettings",
"type": "object"
},
"ItemPartialEmbed": {
"properties": {
"alias": {
"type": "string"
},
"apps": {
"additionalProperties": {
"$ref": "#/components/schemas/ItemEmbedApp"
},
"type": "object"
},
"attachmentCount": {
"format": "int32",
"type": "integer"
},
"children": {
"items": {
"$ref": "#/components/schemas/RelativeItemInfo"
},
"type": "array"
},
"commentCount": {
"format": "int32",
"type": "integer"
},
"constraints": {
"items": {
"$ref": "#/components/schemas/ItemConstraint"
},
"type": "array"
},
"integration": {
"$ref": "#/components/schemas/ItemEmbedIntegration"
},
"linkCount": {
"format": "int32",
"type": "integer"
},
"parents": {
"items": {
"$ref": "#/components/schemas/RelativeItemInfo"
},
"type": "array"
},
"progress": {
"$ref": "#/components/schemas/ItemEmbedProgress"
},
"watched": {
"type": "boolean"
},
"workspaceItemType": {
"$ref": "#/components/schemas/ItemType"
}
},
"title": "ItemPartialEmbed",
"type": "object"
},
"ItemPartialWithItemPartialEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/ItemPartialEmbed"
},
"archived": {
"type": "boolean"
},
"assigneeUserGroupIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"assigneeUserIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"color": {
"$ref": "#/components/schemas/ItemColor"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"$ref": "#/components/schemas/RichText",
"description": "Rich text content as structured blocks. Different media types provide markdown support:\n• application/json - Default blocks format\n• application/vnd.airfocus.markdown+json - All RichText fields become markdown strings (recommended)\n• application/json+markdown - Legacy format, only top-level fields converted to markdown"
},
"fields": {
"additionalProperties": {},
"type": "object"
},
"id": {
"format": "uuid",
"type": "string"
},
"lastUpdatedAt": {
"format": "date-time",
"type": "string"
},
"name": {
"type": "string"
},
"number": {
"format": "int32",
"type": "integer"
},
"order": {
"format": "int32",
"type": "integer"
},
"statusCategoryUpdatedAt": {
"format": "date-time",
"type": "string"
},
"statusId": {
"format": "uuid",
"type": "string"
},
"statusUpdatedAt": {
"format": "date-time",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"_embedded"
],
"title": "ItemPartialWithItemPartialEmbed",
"type": "object"
},
"ItemPartialWithItemPartialEmbedPage": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ItemPartialWithItemPartialEmbed"
},
"type": "array"
},
"totalItems": {
"format": "int32",
"type": "integer"
}
},
"required": [
"items",
"totalItems"
],
"title": "ItemPartialWithItemPartialEmbedPage",
"type": "object"
},
"ItemRelationBulkAction": {
"discriminator": {
"mapping": {
"create": "#/components/schemas/ItemRelationBulkCreate",
"delete": "#/components/schemas/ItemRelationBulkDelete",
"patch": "#/components/schemas/ItemRelationBulkPatch",
"update": "#/components/schemas/ItemRelationBulkUpdate"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ItemRelationBulkCreate"
},
{
"$ref": "#/components/schemas/ItemRelationBulkDelete"
},
{
"$ref": "#/components/schemas/ItemRelationBulkPatch"
},
{
"$ref": "#/components/schemas/ItemRelationBulkUpdate"
}
],
"title": "ItemRelationBulkAction"
},
"ItemRelationBulkCreate": {
"properties": {
"resource": {
"$ref": "#/components/schemas/ItemRelationCreateRequest"
},
"type": {
"enum": [
"create"
],
"type": "string"
}
},
"required": [
"resource",
"type"
],
"title": "ItemRelationBulkCreate",
"type": "object"
},
"ItemRelationBulkDelete": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"type": {
"enum": [
"delete"
],
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "ItemRelationBulkDelete",
"type": "object"
},
"ItemRelationBulkPatch": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"transform": {
"$ref": "#/components/schemas/JsonPatch"
},
"type": {
"enum": [
"patch"
],
"type": "string"
}
},
"required": [
"id",
"transform",
"type"
],
"title": "ItemRelationBulkPatch",
"type": "object"
},
"ItemRelationBulkUpdate": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/ItemRelationUpdateRequest"
},
"type": {
"enum": [
"update"
],
"type": "string"
}
},
"required": [
"id",
"resource",
"type"
],
"title": "ItemRelationBulkUpdate",
"type": "object"
},
"ItemRelationConstraint": {
"discriminator": {
"mapping": {
"readonly": "#/components/schemas/ItemRelationConstraintReadonly"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ItemRelationConstraintReadonly"
}
],
"title": "ItemRelationConstraint"
},
"ItemRelationConstraintReadonly": {
"properties": {
"extensionId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "readonly",
"type": "string"
}
},
"required": [
"extensionId",
"type"
],
"title": "ItemRelationConstraintReadonly",
"type": "object"
},
"ItemRelationCreateRequest": {
"properties": {
"childId": {
"format": "uuid",
"type": "string"
},
"childOrder": {
"format": "int32",
"type": "integer"
},
"parentId": {
"format": "uuid",
"type": "string"
},
"parentOrder": {
"format": "int32",
"type": "integer"
}
},
"required": [
"parentId",
"childId"
],
"title": "ItemRelationCreateRequest",
"type": "object"
},
"ItemRelationEmbed": {
"properties": {
"constraints": {
"items": {
"$ref": "#/components/schemas/ItemRelationConstraint"
},
"type": "array"
}
},
"required": [
"constraints"
],
"title": "ItemRelationEmbed",
"type": "object"
},
"ItemRelationSearchQuery": {
"properties": {
"filter": {
"$ref": "#/components/schemas/ItemRelationSearchQueryFilter"
}
},
"title": "ItemRelationSearchQuery",
"type": "object"
},
"ItemRelationSearchQueryFilter": {
"discriminator": {
"mapping": {
"child": "#/components/schemas/ItemRelationSearchQueryFilterChild",
"parent": "#/components/schemas/ItemRelationSearchQueryFilterParent",
"parentOrChild": "#/components/schemas/ItemRelationSearchQueryFilterParentOrChild"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ItemRelationSearchQueryFilterChild"
},
{
"$ref": "#/components/schemas/ItemRelationSearchQueryFilterParent"
},
{
"$ref": "#/components/schemas/ItemRelationSearchQueryFilterParentOrChild"
}
],
"title": "ItemRelationSearchQueryFilter"
},
"ItemRelationSearchQueryFilterChild": {
"properties": {
"itemId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "child",
"type": "string"
}
},
"required": [
"itemId",
"type"
],
"title": "ItemRelationSearchQueryFilterChild",
"type": "object"
},
"ItemRelationSearchQueryFilterParent": {
"properties": {
"itemId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "parent",
"type": "string"
}
},
"required": [
"itemId",
"type"
],
"title": "ItemRelationSearchQueryFilterParent",
"type": "object"
},
"ItemRelationSearchQueryFilterParentOrChild": {
"properties": {
"itemId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "parentOrChild",
"type": "string"
}
},
"required": [
"itemId",
"type"
],
"title": "ItemRelationSearchQueryFilterParentOrChild",
"type": "object"
},
"ItemRelationUpdateRequest": {
"properties": {
"childOrder": {
"format": "int32",
"type": "integer"
},
"parentOrder": {
"format": "int32",
"type": "integer"
}
},
"required": [
"parentOrder",
"childOrder"
],
"title": "ItemRelationUpdateRequest",
"type": "object"
},
"ItemRelationWithItemRelationEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/ItemRelationEmbed"
},
"childId": {
"format": "uuid",
"type": "string"
},
"childOrder": {
"format": "int32",
"type": "integer"
},
"id": {
"format": "uuid",
"type": "string"
},
"parentId": {
"format": "uuid",
"type": "string"
},
"parentOrder": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"parentId",
"childId",
"parentOrder",
"childOrder",
"_embedded"
],
"title": "ItemRelationWithItemRelationEmbed",
"type": "object"
},
"ItemRelationWithItemRelationEmbedOrNullList": {
"items": {
"$ref": "#/components/schemas/ItemRelationWithItemRelationEmbed"
},
"title": "ItemRelationWithItemRelationEmbedOrNullList",
"type": "array"
},
"ItemRelationWithItemRelationEmbedPage": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ItemRelationWithItemRelationEmbed"
},
"type": "array"
},
"totalItems": {
"format": "int32",
"type": "integer"
}
},
"required": [
"items",
"totalItems"
],
"title": "ItemRelationWithItemRelationEmbedPage",
"type": "object"
},
"ItemScopeLimit": {
"discriminator": {
"mapping": {
"active": "#/components/schemas/ItemScopeLimitActive",
"history": "#/components/schemas/ItemScopeLimitHistory",
"unplanned": "#/components/schemas/ItemScopeLimitUnplanned"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ItemScopeLimitActive"
},
{
"$ref": "#/components/schemas/ItemScopeLimitHistory"
},
{
"$ref": "#/components/schemas/ItemScopeLimitUnplanned"
}
],
"title": "ItemScopeLimit"
},
"ItemScopeLimitActive": {
"properties": {
"closed": {
"$ref": "#/components/schemas/ItemScopeLimitTimeAnchorSetting"
},
"type": {
"const": "active",
"type": "string"
},
"updated": {
"$ref": "#/components/schemas/ItemScopeLimitTimeAnchorSetting"
}
},
"required": [
"closed",
"updated",
"type"
],
"title": "ItemScopeLimitActive",
"type": "object"
},
"ItemScopeLimitHistory": {
"properties": {
"closed": {
"$ref": "#/components/schemas/ItemScopeLimitTimeAnchorSetting"
},
"type": {
"const": "history",
"type": "string"
}
},
"required": [
"closed",
"type"
],
"title": "ItemScopeLimitHistory",
"type": "object"
},
"ItemScopeLimitTimeAnchorSetting": {
"properties": {
"enabled": {
"type": "boolean"
},
"value": {
"$ref": "#/components/schemas/ItemSearchQueryTimeAnchor"
}
},
"required": [
"value",
"enabled"
],
"title": "ItemScopeLimitTimeAnchorSetting",
"type": "object"
},
"ItemScopeLimitUnplanned": {
"properties": {
"created": {
"$ref": "#/components/schemas/ItemScopeLimitTimeAnchorSetting"
},
"type": {
"const": "unplanned",
"type": "string"
}
},
"required": [
"created",
"type"
],
"title": "ItemScopeLimitUnplanned",
"type": "object"
},
"ItemSearchQuery": {
"properties": {
"archived": {
"default": false,
"type": "boolean"
},
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"sort": {
"$ref": "#/components/schemas/ItemSearchQuerySort",
"default": {
"direction": "asc",
"type": "order"
}
}
},
"title": "ItemSearchQuery",
"type": "object"
},
"ItemSearchQueryDateTimeFilterValue": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"time": {
"type": "string"
},
"zoneId": {
"type": "string"
}
},
"required": [
"date",
"zoneId"
],
"title": "ItemSearchQueryDateTimeFilterValue",
"type": "object"
},
"ItemSearchQueryFilter": {
"discriminator": {
"mapping": {
"alias:contain": "#/components/schemas/ItemSearchQueryFilterAliasContain",
"and": "#/components/schemas/ItemSearchQueryFilterAnd",
"archived:value": "#/components/schemas/ItemSearchQueryFilterArchivedValue",
"assignees:contain": "#/components/schemas/ItemSearchQueryFilterAssigneesContain",
"assignees:containsAll": "#/components/schemas/ItemSearchQueryFilterAssigneesContainsAll",
"assignees:containsAny": "#/components/schemas/ItemSearchQueryFilterAssigneesContainsAny",
"assignees:defined": "#/components/schemas/ItemSearchQueryFilterAssigneesDefined",
"completionTime:between": "#/components/schemas/ItemSearchQueryFilterCompletionTimeBetween",
"createdAt:absolute": "#/components/schemas/ItemSearchQueryFilterCreatedAtAbsolute",
"createdAt:range": "#/components/schemas/ItemSearchQueryFilterCreatedAtRange",
"createdAt:relative": "#/components/schemas/ItemSearchQueryFilterCreatedAtRelative",
"description:contain": "#/components/schemas/ItemSearchQueryFilterDescriptionContain",
"description:defined": "#/components/schemas/ItemSearchQueryFilterDescriptionDefined",
"field:type": "#/components/schemas/ItemSearchQueryFilterFieldType",
"field:value": "#/components/schemas/ItemSearchQueryFilterFieldValue",
"integration:defined": "#/components/schemas/ItemSearchQueryFilterIntegrationDefined",
"integration:value": "#/components/schemas/ItemSearchQueryFilterIntegrationValue",
"item:watchSelf": "#/components/schemas/ItemSearchQueryFilterItemWatchSelf",
"lastUpdatedAt:absolute": "#/components/schemas/ItemSearchQueryFilterLastUpdatedAtAbsolute",
"lastUpdatedAt:range": "#/components/schemas/ItemSearchQueryFilterLastUpdatedAtRange",
"lastUpdatedAt:relative": "#/components/schemas/ItemSearchQueryFilterLastUpdatedAtRelative",
"name:contain": "#/components/schemas/ItemSearchQueryFilterNameContain",
"name:equal": "#/components/schemas/ItemSearchQueryFilterNameEqual",
"not": "#/components/schemas/ItemSearchQueryFilterNot",
"or": "#/components/schemas/ItemSearchQueryFilterOr",
"parent:defined": "#/components/schemas/ItemSearchQueryFilterParentDefined",
"parent:value": "#/components/schemas/ItemSearchQueryFilterParentValue",
"status:containsAny": "#/components/schemas/ItemSearchQueryFilterStatusContainsAny",
"status:updatedSince": "#/components/schemas/ItemSearchQueryFilterStatusUpdatedSince",
"statusCategory:containsAny": "#/components/schemas/ItemSearchQueryFilterStatusCategoryContainsAny",
"statusCategory:updatedBetween": "#/components/schemas/ItemSearchQueryFilterStatusCategoryUpdatedBetween",
"statusCategory:updatedSince": "#/components/schemas/ItemSearchQueryFilterStatusCategoryUpdatedSince",
"updated:since": "#/components/schemas/ItemSearchQueryFilterUpdatedSince",
"workspace:contains": "#/components/schemas/ItemSearchQueryFilterWorkspaceContains",
"workspace:containsAny": "#/components/schemas/ItemSearchQueryFilterWorkspaceContainsAny"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ItemSearchQueryFilterAliasContain"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterAnd"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterArchivedValue"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterAssigneesContain"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterAssigneesContainsAll"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterAssigneesContainsAny"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterAssigneesDefined"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterCompletionTimeBetween"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterCreatedAtAbsolute"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterCreatedAtRange"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterCreatedAtRelative"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterDescriptionContain"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterDescriptionDefined"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterFieldType"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterFieldValue"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterIntegrationDefined"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterIntegrationValue"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterItemWatchSelf"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterLastUpdatedAtAbsolute"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterLastUpdatedAtRange"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterLastUpdatedAtRelative"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterNameContain"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterNameEqual"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterNot"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterOr"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterParentDefined"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterParentValue"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterStatusCategoryContainsAny"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterStatusCategoryUpdatedBetween"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterStatusCategoryUpdatedSince"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterStatusContainsAny"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterStatusUpdatedSince"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterUpdatedSince"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterWorkspaceContains"
},
{
"$ref": "#/components/schemas/ItemSearchQueryFilterWorkspaceContainsAny"
}
],
"title": "ItemSearchQueryFilter"
},
"ItemSearchQueryFilterAliasContain": {
"properties": {
"caseSensitive": {
"type": "boolean"
},
"text": {
"type": "string"
},
"type": {
"const": "alias:contain",
"type": "string"
}
},
"required": [
"text",
"caseSensitive",
"type"
],
"title": "ItemSearchQueryFilterAliasContain",
"type": "object"
},
"ItemSearchQueryFilterAnd": {
"properties": {
"inner": {
"items": {
"$ref": "#/components/schemas/ItemSearchQueryFilter"
},
"type": "array"
},
"type": {
"const": "and",
"type": "string"
}
},
"required": [
"inner",
"type"
],
"title": "ItemSearchQueryFilterAnd",
"type": "object"
},
"ItemSearchQueryFilterArchivedValue": {
"properties": {
"type": {
"const": "archived:value",
"type": "string"
},
"value": {
"type": "boolean"
}
},
"required": [
"value",
"type"
],
"title": "ItemSearchQueryFilterArchivedValue",
"type": "object"
},
"ItemSearchQueryFilterAssigneesContain": {
"properties": {
"type": {
"const": "assignees:contain",
"type": "string"
},
"user": {
"$ref": "#/components/schemas/UserRef"
}
},
"required": [
"user",
"type"
],
"title": "ItemSearchQueryFilterAssigneesContain",
"type": "object"
},
"ItemSearchQueryFilterAssigneesContainsAll": {
"properties": {
"type": {
"const": "assignees:containsAll",
"type": "string"
},
"users": {
"items": {
"$ref": "#/components/schemas/UserRef"
},
"type": "array"
}
},
"required": [
"users",
"type"
],
"title": "ItemSearchQueryFilterAssigneesContainsAll",
"type": "object"
},
"ItemSearchQueryFilterAssigneesContainsAny": {
"properties": {
"type": {
"const": "assignees:containsAny",
"type": "string"
},
"users": {
"items": {
"$ref": "#/components/schemas/UserRef"
},
"type": "array"
}
},
"required": [
"users",
"type"
],
"title": "ItemSearchQueryFilterAssigneesContainsAny",
"type": "object"
},
"ItemSearchQueryFilterAssigneesDefined": {
"properties": {
"type": {
"const": "assignees:defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "ItemSearchQueryFilterAssigneesDefined",
"type": "object"
},
"ItemSearchQueryFilterCompletionTimeBetween": {
"properties": {
"end": {
"description": "end range in days",
"format": "int32",
"type": "integer"
},
"start": {
"description": "start range in days",
"format": "int32",
"type": "integer"
},
"type": {
"const": "completionTime:between",
"type": "string"
}
},
"required": [
"start",
"end",
"type"
],
"title": "ItemSearchQueryFilterCompletionTimeBetween",
"type": "object"
},
"ItemSearchQueryFilterCreatedAtAbsolute": {
"properties": {
"mode": {
"$ref": "#/components/schemas/ItemSearchQueryTimeMode"
},
"type": {
"const": "createdAt:absolute",
"type": "string"
},
"value": {
"$ref": "#/components/schemas/ItemSearchQueryDateTimeFilterValue"
}
},
"required": [
"mode",
"value",
"type"
],
"title": "ItemSearchQueryFilterCreatedAtAbsolute",
"type": "object"
},
"ItemSearchQueryFilterCreatedAtRange": {
"properties": {
"from": {
"format": "date",
"type": "string"
},
"type": {
"const": "createdAt:range",
"type": "string"
},
"until": {
"format": "date",
"type": "string"
}
},
"required": [
"from",
"until",
"type"
],
"title": "ItemSearchQueryFilterCreatedAtRange",
"type": "object"
},
"ItemSearchQueryFilterCreatedAtRelative": {
"properties": {
"anchor": {
"$ref": "#/components/schemas/ItemSearchQueryTimeAnchor"
},
"type": {
"const": "createdAt:relative",
"type": "string"
}
},
"required": [
"anchor",
"type"
],
"title": "ItemSearchQueryFilterCreatedAtRelative",
"type": "object"
},
"ItemSearchQueryFilterDescriptionContain": {
"properties": {
"caseSensitive": {
"type": "boolean"
},
"text": {
"type": "string"
},
"type": {
"const": "description:contain",
"type": "string"
}
},
"required": [
"text",
"caseSensitive",
"type"
],
"title": "ItemSearchQueryFilterDescriptionContain",
"type": "object"
},
"ItemSearchQueryFilterDescriptionDefined": {
"properties": {
"type": {
"const": "description:defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "ItemSearchQueryFilterDescriptionDefined",
"type": "object"
},
"ItemSearchQueryFilterFieldType": {
"properties": {
"fieldType": {
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/BooleanFieldTypeFilter"
},
{
"$ref": "#/components/schemas/DateFieldTypeFilter"
},
{
"$ref": "#/components/schemas/DateRangeFieldTypeFilter"
},
{
"$ref": "#/components/schemas/FormSourceFieldTypeFilter"
},
{
"$ref": "#/components/schemas/FormsTargetFieldTypeFilter"
},
{
"$ref": "#/components/schemas/HealthCheckInsConfidenceFieldFilter"
},
{
"$ref": "#/components/schemas/InsightsFieldTypeFilter"
},
{
"$ref": "#/components/schemas/MilestoneFieldFilter"
},
{
"$ref": "#/components/schemas/MirrorSourceFieldTypeFilter"
},
{
"$ref": "#/components/schemas/MirrorTargetFieldTypeFilter"
},
{
"$ref": "#/components/schemas/NumberFieldTypeLikeFilter"
},
{
"$ref": "#/components/schemas/OkrConfidenceFieldFilter"
},
{
"$ref": "#/components/schemas/OkrKeyResultReferenceFieldFilter"
},
{
"$ref": "#/components/schemas/OkrKeyResultsFieldFilter"
},
{
"$ref": "#/components/schemas/PeopleFieldTypeFilter"
},
{
"$ref": "#/components/schemas/PortalFieldTypeFilter"
},
{
"$ref": "#/components/schemas/PortfolioSourceFieldFilter"
},
{
"$ref": "#/components/schemas/SelectFieldTypeFilter"
},
{
"$ref": "#/components/schemas/TextFieldTypeFilter"
},
{
"$ref": "#/components/schemas/TimePeriodFieldFilter"
},
{
"$ref": "#/components/schemas/VotingAppVotesFieldTypeFilter"
}
]
},
"type": {
"const": "field:type",
"type": "string"
}
},
"required": [
"fieldType",
"filter",
"type"
],
"title": "ItemSearchQueryFilterFieldType",
"type": "object"
},
"ItemSearchQueryFilterFieldValue": {
"properties": {
"fieldId": {
"format": "uuid",
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/BooleanFieldTypeFilter"
},
{
"$ref": "#/components/schemas/DateFieldTypeFilter"
},
{
"$ref": "#/components/schemas/DateRangeFieldTypeFilter"
},
{
"$ref": "#/components/schemas/FormSourceFieldTypeFilter"
},
{
"$ref": "#/components/schemas/FormsTargetFieldTypeFilter"
},
{
"$ref": "#/components/schemas/HealthCheckInsConfidenceFieldFilter"
},
{
"$ref": "#/components/schemas/InsightsFieldTypeFilter"
},
{
"$ref": "#/components/schemas/MilestoneFieldFilter"
},
{
"$ref": "#/components/schemas/MirrorSourceFieldTypeFilter"
},
{
"$ref": "#/components/schemas/MirrorTargetFieldTypeFilter"
},
{
"$ref": "#/components/schemas/NumberFieldTypeLikeFilter"
},
{
"$ref": "#/components/schemas/OkrConfidenceFieldFilter"
},
{
"$ref": "#/components/schemas/OkrKeyResultReferenceFieldFilter"
},
{
"$ref": "#/components/schemas/OkrKeyResultsFieldFilter"
},
{
"$ref": "#/components/schemas/PeopleFieldTypeFilter"
},
{
"$ref": "#/components/schemas/PortalFieldTypeFilter"
},
{
"$ref": "#/components/schemas/PortfolioSourceFieldFilter"
},
{
"$ref": "#/components/schemas/SelectFieldTypeFilter"
},
{
"$ref": "#/components/schemas/TextFieldTypeFilter"
},
{
"$ref": "#/components/schemas/TimePeriodFieldFilter"
},
{
"$ref": "#/components/schemas/VotingAppVotesFieldTypeFilter"
}
]
},
"type": {
"const": "field:value",
"type": "string"
}
},
"required": [
"fieldId",
"filter",
"type"
],
"title": "ItemSearchQueryFilterFieldValue",
"type": "object"
},
"ItemSearchQueryFilterIntegrationDefined": {
"properties": {
"type": {
"const": "integration:defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "ItemSearchQueryFilterIntegrationDefined",
"type": "object"
},
"ItemSearchQueryFilterIntegrationValue": {
"properties": {
"integrationId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "integration:value",
"type": "string"
}
},
"required": [
"integrationId",
"type"
],
"title": "ItemSearchQueryFilterIntegrationValue",
"type": "object"
},
"ItemSearchQueryFilterItemWatchSelf": {
"properties": {
"type": {
"const": "item:watchSelf",
"type": "string"
}
},
"required": [
"type"
],
"title": "ItemSearchQueryFilterItemWatchSelf",
"type": "object"
},
"ItemSearchQueryFilterLastUpdatedAtAbsolute": {
"properties": {
"mode": {
"$ref": "#/components/schemas/ItemSearchQueryTimeMode"
},
"property": {
"$ref": "#/components/schemas/RefItemProperty"
},
"type": {
"const": "lastUpdatedAt:absolute",
"type": "string"
},
"value": {
"$ref": "#/components/schemas/ItemSearchQueryDateTimeFilterValue"
}
},
"required": [
"mode",
"value",
"type"
],
"title": "ItemSearchQueryFilterLastUpdatedAtAbsolute",
"type": "object"
},
"ItemSearchQueryFilterLastUpdatedAtRange": {
"properties": {
"from": {
"format": "date",
"type": "string"
},
"property": {
"$ref": "#/components/schemas/RefItemProperty"
},
"type": {
"const": "lastUpdatedAt:range",
"type": "string"
},
"until": {
"format": "date",
"type": "string"
}
},
"required": [
"from",
"until",
"type"
],
"title": "ItemSearchQueryFilterLastUpdatedAtRange",
"type": "object"
},
"ItemSearchQueryFilterLastUpdatedAtRelative": {
"properties": {
"anchor": {
"$ref": "#/components/schemas/ItemSearchQueryTimeAnchor"
},
"property": {
"$ref": "#/components/schemas/RefItemProperty"
},
"type": {
"const": "lastUpdatedAt:relative",
"type": "string"
}
},
"required": [
"anchor",
"type"
],
"title": "ItemSearchQueryFilterLastUpdatedAtRelative",
"type": "object"
},
"ItemSearchQueryFilterNameContain": {
"properties": {
"caseSensitive": {
"type": "boolean"
},
"text": {
"type": "string"
},
"type": {
"const": "name:contain",
"type": "string"
}
},
"required": [
"text",
"caseSensitive",
"type"
],
"title": "ItemSearchQueryFilterNameContain",
"type": "object"
},
"ItemSearchQueryFilterNameEqual": {
"properties": {
"caseSensitive": {
"type": "boolean"
},
"text": {
"type": "string"
},
"type": {
"const": "name:equal",
"type": "string"
}
},
"required": [
"text",
"caseSensitive",
"type"
],
"title": "ItemSearchQueryFilterNameEqual",
"type": "object"
},
"ItemSearchQueryFilterNot": {
"properties": {
"inner": {
"$ref": "#/components/schemas/ItemSearchQueryFilter"
},
"type": {
"const": "not",
"type": "string"
}
},
"required": [
"inner",
"type"
],
"title": "ItemSearchQueryFilterNot",
"type": "object"
},
"ItemSearchQueryFilterOr": {
"properties": {
"inner": {
"items": {
"$ref": "#/components/schemas/ItemSearchQueryFilter"
},
"type": "array"
},
"type": {
"const": "or",
"type": "string"
}
},
"required": [
"inner",
"type"
],
"title": "ItemSearchQueryFilterOr",
"type": "object"
},
"ItemSearchQueryFilterParentDefined": {
"properties": {
"type": {
"const": "parent:defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "ItemSearchQueryFilterParentDefined",
"type": "object"
},
"ItemSearchQueryFilterParentValue": {
"properties": {
"itemId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "parent:value",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"workspaceId",
"itemId",
"type"
],
"title": "ItemSearchQueryFilterParentValue",
"type": "object"
},
"ItemSearchQueryFilterStatusCategoryContainsAny": {
"properties": {
"categories": {
"items": {
"$ref": "#/components/schemas/StatusCategory"
},
"type": "array",
"uniqueItems": true
},
"type": {
"const": "statusCategory:containsAny",
"type": "string"
}
},
"required": [
"categories",
"type"
],
"title": "ItemSearchQueryFilterStatusCategoryContainsAny",
"type": "object"
},
"ItemSearchQueryFilterStatusCategoryUpdatedBetween": {
"properties": {
"end": {
"format": "date",
"type": "string"
},
"start": {
"format": "date",
"type": "string"
},
"type": {
"const": "statusCategory:updatedBetween",
"type": "string"
}
},
"required": [
"start",
"end",
"type"
],
"title": "ItemSearchQueryFilterStatusCategoryUpdatedBetween",
"type": "object"
},
"ItemSearchQueryFilterStatusCategoryUpdatedSince": {
"properties": {
"type": {
"const": "statusCategory:updatedSince",
"type": "string"
},
"value": {
"$ref": "#/components/schemas/ItemSearchQueryTimeAnchor"
}
},
"required": [
"value",
"type"
],
"title": "ItemSearchQueryFilterStatusCategoryUpdatedSince",
"type": "object"
},
"ItemSearchQueryFilterStatusContainsAny": {
"properties": {
"statusIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"type": {
"const": "status:containsAny",
"type": "string"
}
},
"required": [
"statusIds",
"type"
],
"title": "ItemSearchQueryFilterStatusContainsAny",
"type": "object"
},
"ItemSearchQueryFilterStatusUpdatedSince": {
"properties": {
"type": {
"const": "status:updatedSince",
"type": "string"
},
"value": {
"$ref": "#/components/schemas/ItemSearchQueryTimeAnchor"
}
},
"required": [
"value",
"type"
],
"title": "ItemSearchQueryFilterStatusUpdatedSince",
"type": "object"
},
"ItemSearchQueryFilterUpdatedSince": {
"properties": {
"property": {
"$ref": "#/components/schemas/RefItemProperty"
},
"timestamp": {
"format": "date-time",
"type": "string"
},
"type": {
"const": "updated:since",
"type": "string"
}
},
"required": [
"timestamp",
"type"
],
"title": "ItemSearchQueryFilterUpdatedSince",
"type": "object"
},
"ItemSearchQueryFilterWorkspaceContains": {
"deprecated": true,
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "workspace:contains",
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "ItemSearchQueryFilterWorkspaceContains",
"type": "object"
},
"ItemSearchQueryFilterWorkspaceContainsAny": {
"properties": {
"type": {
"const": "workspace:containsAny",
"type": "string"
},
"workspaceIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"workspaceIds",
"type"
],
"title": "ItemSearchQueryFilterWorkspaceContainsAny",
"type": "object"
},
"ItemSearchQuerySort": {
"discriminator": {
"mapping": {
"createdAt": "#/components/schemas/ItemSearchQuerySortCreatedAt",
"field": "#/components/schemas/ItemSearchQuerySortField",
"fieldType": "#/components/schemas/ItemSearchQuerySortFieldType",
"lastUpdatedAt": "#/components/schemas/ItemSearchQuerySortLastUpdatedAt",
"name": "#/components/schemas/ItemSearchQuerySortName",
"order": "#/components/schemas/ItemSearchQuerySortOrder",
"status": "#/components/schemas/ItemSearchQuerySortStatus"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ItemSearchQuerySortCreatedAt"
},
{
"$ref": "#/components/schemas/ItemSearchQuerySortField"
},
{
"$ref": "#/components/schemas/ItemSearchQuerySortFieldType"
},
{
"$ref": "#/components/schemas/ItemSearchQuerySortLastUpdatedAt"
},
{
"$ref": "#/components/schemas/ItemSearchQuerySortName"
},
{
"$ref": "#/components/schemas/ItemSearchQuerySortOrder"
},
{
"$ref": "#/components/schemas/ItemSearchQuerySortStatus"
}
],
"title": "ItemSearchQuerySort"
},
"ItemSearchQuerySortCreatedAt": {
"properties": {
"direction": {
"$ref": "#/components/schemas/ItemSearchQuerySortDirection"
},
"type": {
"const": "createdAt",
"type": "string"
}
},
"required": [
"direction",
"type"
],
"title": "ItemSearchQuerySortCreatedAt",
"type": "object"
},
"ItemSearchQuerySortDirection": {
"enum": [
"asc",
"desc"
],
"title": "ItemSearchQuerySortDirection",
"type": "string"
},
"ItemSearchQuerySortField": {
"properties": {
"direction": {
"$ref": "#/components/schemas/ItemSearchQuerySortDirection"
},
"fieldId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "field",
"type": "string"
}
},
"required": [
"fieldId",
"direction",
"type"
],
"title": "ItemSearchQuerySortField",
"type": "object"
},
"ItemSearchQuerySortFieldType": {
"properties": {
"direction": {
"$ref": "#/components/schemas/ItemSearchQuerySortDirection"
},
"fieldType": {
"type": "string"
},
"type": {
"const": "fieldType",
"type": "string"
}
},
"required": [
"fieldType",
"direction",
"type"
],
"title": "ItemSearchQuerySortFieldType",
"type": "object"
},
"ItemSearchQuerySortLastUpdatedAt": {
"properties": {
"direction": {
"$ref": "#/components/schemas/ItemSearchQuerySortDirection"
},
"type": {
"const": "lastUpdatedAt",
"type": "string"
}
},
"required": [
"direction",
"type"
],
"title": "ItemSearchQuerySortLastUpdatedAt",
"type": "object"
},
"ItemSearchQuerySortName": {
"properties": {
"direction": {
"$ref": "#/components/schemas/ItemSearchQuerySortDirection"
},
"type": {
"const": "name",
"type": "string"
}
},
"required": [
"direction",
"type"
],
"title": "ItemSearchQuerySortName",
"type": "object"
},
"ItemSearchQuerySortOrder": {
"properties": {
"direction": {
"$ref": "#/components/schemas/ItemSearchQuerySortDirection"
},
"type": {
"const": "order",
"type": "string"
}
},
"required": [
"direction",
"type"
],
"title": "ItemSearchQuerySortOrder",
"type": "object"
},
"ItemSearchQuerySortStatus": {
"properties": {
"direction": {
"$ref": "#/components/schemas/ItemSearchQuerySortDirection"
},
"type": {
"const": "status",
"type": "string"
}
},
"required": [
"direction",
"type"
],
"title": "ItemSearchQuerySortStatus",
"type": "object"
},
"ItemSearchQueryTimeAnchor": {
"discriminator": {
"mapping": {
"days": "#/components/schemas/ItemSearchQueryTimeAnchorDays",
"months": "#/components/schemas/ItemSearchQueryTimeAnchorMonths",
"weeks": "#/components/schemas/ItemSearchQueryTimeAnchorWeeks"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ItemSearchQueryTimeAnchorDays"
},
{
"$ref": "#/components/schemas/ItemSearchQueryTimeAnchorMonths"
},
{
"$ref": "#/components/schemas/ItemSearchQueryTimeAnchorWeeks"
}
],
"title": "ItemSearchQueryTimeAnchor"
},
"ItemSearchQueryTimeAnchorDays": {
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"type": {
"const": "days",
"type": "string"
}
},
"required": [
"count",
"type"
],
"title": "ItemSearchQueryTimeAnchorDays",
"type": "object"
},
"ItemSearchQueryTimeAnchorMonths": {
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"type": {
"const": "months",
"type": "string"
}
},
"required": [
"count",
"type"
],
"title": "ItemSearchQueryTimeAnchorMonths",
"type": "object"
},
"ItemSearchQueryTimeAnchorWeeks": {
"properties": {
"count": {
"format": "int32",
"type": "integer"
},
"type": {
"const": "weeks",
"type": "string"
}
},
"required": [
"count",
"type"
],
"title": "ItemSearchQueryTimeAnchorWeeks",
"type": "object"
},
"ItemSearchQueryTimeMode": {
"enum": [
"after",
"afterOrOn",
"before",
"beforeOrOn"
],
"title": "ItemSearchQueryTimeMode",
"type": "string"
},
"ItemType": {
"enum": [
"bug",
"epic",
"experiment",
"feature",
"feedback",
"idea",
"initiative",
"app:okr:objective",
"opportunity",
"product",
"project",
"story",
"task"
],
"title": "ItemType",
"type": "string"
},
"ItemWithItemEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/ItemEmbed"
},
"archived": {
"description": "Whether this item is archived.",
"type": "boolean"
},
"assigneeUserGroupIds": {
"description": "Ids of user groups that are assigned to this item.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"assigneeUserIds": {
"description": "Ids of users who are assigned to this item.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"color": {
"$ref": "#/components/schemas/ItemColor",
"description": "Color of this item."
},
"createdAt": {
"description": "Timestamp of when this item was created.",
"format": "date-time",
"type": "string"
},
"description": {
"$ref": "#/components/schemas/RichText",
"description": "Rich text content as structured blocks. Different media types provide markdown support:\n• application/json - Default blocks format\n• application/vnd.airfocus.markdown+json - All RichText fields become markdown strings (recommended)\n• application/json+markdown - Legacy format, only top-level fields converted to markdown"
},
"fields": {
"additionalProperties": {},
"description": "Values of custom fields, where each key is a custom-field ID and each value is a JSON-formatted value of the corresponding field.",
"examples": [
{
"0fc3cfbc-27e9-3ea6-8a78-7de13dae3e3c": {
"number": 42
},
"34f05b62-dd43-3e1e-82bc-b0acabd0d004": {
"boolean": true
},
"5396681e-ea50-3d63-9ae3-c9f8ca17b7d8": {
"userGroupIds": [
"70e2b87a-b774-3022-9ef0-e55031a1c4fb"
],
"userIds": [
"24c9e15e-52af-347c-a25b-757e7bee1f9d"
]
},
"75fe57ec-4a04-3a30-8cac-5f27223df81a": {
"dateRange": {
"endDate": "2024-02-14",
"startDate": "2024-01-14",
"timezone": "UTC"
}
},
"8be74552-df93-331b-bdd6-b36ed74bdb6a": {
"selection": [
"2bb225ce-b5ee-3493-967c-fde0d72da242"
]
},
"c7824f3d-4d5f-3b2f-a2d0-34758c1e9454": {
"text": "A platform built for the new way of doing product management"
},
"e34d514f-7db5-38aa-872a-7c8191a09617": {
"date": {
"date": "2024-01-01",
"timezone": "UTC"
}
}
}
],
"type": "object"
},
"id": {
"description": "Unique identifier of this item.",
"format": "uuid",
"type": "string"
},
"lastUpdatedAt": {
"description": "Timestamp of when this item was last updated.",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name (title) of this item.",
"type": "string"
},
"number": {
"description": "A numeric id of this item, which is used to create an alias to this item like DEV-123. The number is unique within the workspace, and defined by server on item creation.",
"format": "int32",
"type": "integer"
},
"order": {
"description": "A order number of this item for sorting.",
"format": "int32",
"type": "integer"
},
"statusCategoryUpdatedAt": {
"description": "Timestamp of when the status of this item was last time switched from one category to another.",
"format": "date-time",
"type": "string"
},
"statusId": {
"description": "Id of the status of this item.",
"format": "uuid",
"type": "string"
},
"statusUpdatedAt": {
"description": "Timestamp of when the status of this item was last updated.",
"format": "date-time",
"type": "string"
},
"workspaceId": {
"description": "Id of the workspace this workspace belongs to.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"statusId",
"color",
"name",
"description",
"assigneeUserIds",
"assigneeUserGroupIds",
"fields",
"archived",
"createdAt",
"lastUpdatedAt",
"order",
"_embedded"
],
"title": "ItemWithItemEmbed",
"type": "object"
},
"ItemWithItemEmbedOrNullList": {
"items": {
"$ref": "#/components/schemas/ItemWithItemEmbed"
},
"title": "ItemWithItemEmbedOrNullList",
"type": "array"
},
"ItemWithItemEmbedPage": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ItemWithItemEmbed"
},
"type": "array"
},
"totalItems": {
"format": "int32",
"type": "integer"
}
},
"required": [
"items",
"totalItems"
],
"title": "ItemWithItemEmbedPage",
"type": "object"
},
"ItemWithMDWithItemEmbed": {
"description": "Item with Markdown string description.",
"properties": {
"_embedded": {
"$ref": "#/components/schemas/ItemEmbed"
},
"archived": {
"description": "Whether this item is archived.",
"type": "boolean"
},
"assigneeUserGroupIds": {
"description": "Ids of user groups that are assigned to this item.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"assigneeUserIds": {
"description": "Ids of users who are assigned to this item.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"color": {
"$ref": "#/components/schemas/ItemColor",
"description": "Color of this item."
},
"createdAt": {
"description": "Timestamp of when this item was created.",
"format": "date-time",
"type": "string"
},
"description": {
"description": "Rich text content as a markdown string (used with markdown media types)",
"examples": [
"hello **world**!"
],
"type": "string"
},
"fields": {
"additionalProperties": {},
"description": "Values of custom fields, where each key is a custom-field ID and each value is a JSON-formatted value of the corresponding field.",
"examples": [
{
"0fc3cfbc-27e9-3ea6-8a78-7de13dae3e3c": {
"number": 42
},
"34f05b62-dd43-3e1e-82bc-b0acabd0d004": {
"boolean": true
},
"5396681e-ea50-3d63-9ae3-c9f8ca17b7d8": {
"userGroupIds": [
"70e2b87a-b774-3022-9ef0-e55031a1c4fb"
],
"userIds": [
"24c9e15e-52af-347c-a25b-757e7bee1f9d"
]
},
"75fe57ec-4a04-3a30-8cac-5f27223df81a": {
"dateRange": {
"endDate": "2024-02-14",
"startDate": "2024-01-14",
"timezone": "UTC"
}
},
"8be74552-df93-331b-bdd6-b36ed74bdb6a": {
"selection": [
"2bb225ce-b5ee-3493-967c-fde0d72da242"
]
},
"c7824f3d-4d5f-3b2f-a2d0-34758c1e9454": {
"text": "A platform built for the new way of doing product management"
},
"e34d514f-7db5-38aa-872a-7c8191a09617": {
"date": {
"date": "2024-01-01",
"timezone": "UTC"
}
}
}
],
"type": "object"
},
"id": {
"description": "Unique identifier of this item.",
"format": "uuid",
"type": "string"
},
"lastUpdatedAt": {
"description": "Timestamp of when this item was last updated.",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name (title) of this item.",
"type": "string"
},
"number": {
"description": "A numeric id of this item, which is used to create an alias to this item like DEV-123. The number is unique within the workspace, and defined by server on item creation.",
"format": "int32",
"type": "integer"
},
"order": {
"description": "A order number of this item for sorting.",
"format": "int32",
"type": "integer"
},
"statusCategoryUpdatedAt": {
"description": "Timestamp of when the status of this item was last time switched from one category to another.",
"format": "date-time",
"type": "string"
},
"statusId": {
"description": "Id of the status of this item.",
"format": "uuid",
"type": "string"
},
"statusUpdatedAt": {
"description": "Timestamp of when the status of this item was last updated.",
"format": "date-time",
"type": "string"
},
"workspaceId": {
"description": "Id of the workspace this workspace belongs to.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"statusId",
"color",
"name",
"description",
"assigneeUserIds",
"assigneeUserGroupIds",
"fields",
"archived",
"createdAt",
"lastUpdatedAt",
"order",
"_embedded"
],
"title": "ItemWithMDWithItemEmbed",
"type": "object"
},
"ItemWithMDWithItemEmbedOrNullList": {
"items": {
"$ref": "#/components/schemas/ItemWithMDWithItemEmbed"
},
"title": "ItemWithMDWithItemEmbedOrNullList",
"type": "array"
},
"ItemWithMDWithItemEmbedPage": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ItemWithMDWithItemEmbed"
},
"type": "array"
},
"totalItems": {
"format": "int32",
"type": "integer"
}
},
"required": [
"items",
"totalItems"
],
"title": "ItemWithMDWithItemEmbedPage",
"type": "object"
},
"JiraAppLink": {
"properties": {
"incomingConsumerKey": {
"type": "string"
},
"incomingKeyPairPrivateKey": {
"type": "string"
},
"incomingKeyPairPublicKey": {
"type": "string"
},
"outgoingConsumerKey": {
"type": "string"
},
"outgoingSharedSecret": {
"type": "string"
}
},
"required": [
"outgoingConsumerKey",
"outgoingSharedSecret",
"incomingConsumerKey",
"incomingKeyPairPublicKey",
"incomingKeyPairPrivateKey"
],
"title": "JiraAppLink",
"type": "object"
},
"JiraAppLinkToken": {
"properties": {
"token": {
"type": "string"
},
"tokenSecret": {
"type": "string"
}
},
"required": [
"token",
"tokenSecret"
],
"title": "JiraAppLinkToken",
"type": "object"
},
"JiraAuthentication": {
"discriminator": {
"mapping": {
"appLinkOAuth1": "#/components/schemas/JiraAuthenticationAppLinkOAuth1",
"basicAuthentication": "#/components/schemas/JiraAuthenticationBasicAuthentication"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/JiraAuthenticationAppLinkOAuth1"
},
{
"$ref": "#/components/schemas/JiraAuthenticationBasicAuthentication"
}
],
"title": "JiraAuthentication"
},
"JiraAuthenticationAppLinkOAuth1": {
"properties": {
"incomingConsumerKey": {
"type": "string"
},
"incomingKeyPairPrivateKey": {
"type": "string"
},
"incomingKeyPairPublicKey": {
"type": "string"
},
"outgoingConsumerKey": {
"type": "string"
},
"outgoingSharedSecret": {
"type": "string"
},
"token": {
"$ref": "#/components/schemas/JiraAuthenticationAppLinkOAuth1Token"
},
"type": {
"const": "appLinkOAuth1",
"type": "string"
}
},
"required": [
"outgoingConsumerKey",
"outgoingSharedSecret",
"incomingConsumerKey",
"incomingKeyPairPublicKey",
"incomingKeyPairPrivateKey",
"token",
"type"
],
"title": "JiraAuthenticationAppLinkOAuth1",
"type": "object"
},
"JiraAuthenticationAppLinkOAuth1Token": {
"properties": {
"secret": {
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"secret"
],
"title": "JiraAuthenticationAppLinkOAuth1Token",
"type": "object"
},
"JiraAuthenticationBasicAuthentication": {
"properties": {
"password": {
"type": "string"
},
"type": {
"const": "basicAuthentication",
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"username",
"password",
"type"
],
"title": "JiraAuthenticationBasicAuthentication",
"type": "object"
},
"JiraIntegrationSummary": {
"properties": {
"capabilities": {
"$ref": "#/components/schemas/IntegrationCapabilities"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"lastSyncAt": {
"format": "date-time",
"type": "string"
},
"lastSyncState": {
"$ref": "#/components/schemas/IntegrationSyncState"
},
"settings": {
"$ref": "#/components/schemas/JiraIntegrationTypeSettings"
},
"typeId": {
"const": "jira",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"createdAt",
"capabilities",
"enabled"
],
"title": "JiraIntegrationSummary",
"type": "object"
},
"JiraIntegrationTypeSettings": {
"properties": {
"appLink": {
"$ref": "#/components/schemas/JiraAppLink"
},
"appLinkToken": {
"$ref": "#/components/schemas/JiraAppLinkToken"
},
"authentication": {
"$ref": "#/components/schemas/JiraAuthentication"
},
"autoSync": {
"type": "boolean"
},
"baseUrl": {
"type": "string"
},
"issueType": {
"type": "string"
},
"itemAssociationMappings": {
"default": [],
"items": {
"$ref": "#/components/schemas/MappingSettingsIntegrationItemAssociationMappingSettings"
},
"type": "array"
},
"jql": {
"type": "string"
},
"mappings": {
"default": [],
"items": {
"$ref": "#/components/schemas/MappingSettingsIntegrationMappingSettings"
},
"type": "array"
},
"projectName": {
"type": "string"
},
"proxyBaseUrl": {
"type": "string"
},
"removeExtraneous": {
"type": "boolean"
},
"selectProject": {
"type": "string"
},
"signatureBaseUrl": {
"type": "string"
},
"sslConfiguration": {
"$ref": "#/components/schemas/IntegrationSslConfiguration"
},
"title": {
"type": "string"
}
},
"required": [
"removeExtraneous",
"autoSync"
],
"title": "JiraIntegrationTypeSettings",
"type": "object"
},
"JsonPatch": {
"description": "A JSON Patch document. See https://jsonpatch.com/ for more information.",
"items": {
"$ref": "#/components/schemas/JsonPatchOperation"
},
"title": "JsonPatch",
"type": "array"
},
"JsonPatchAdd": {
"properties": {
"op": {
"enum": [
"add"
],
"type": "string"
},
"path": {
"type": "string"
},
"value": {}
},
"required": [
"path",
"value",
"op"
],
"title": "JsonPatchAdd",
"type": "object"
},
"JsonPatchCopy": {
"properties": {
"from": {
"type": "string"
},
"op": {
"enum": [
"copy"
],
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"from",
"path",
"op"
],
"title": "JsonPatchCopy",
"type": "object"
},
"JsonPatchMove": {
"properties": {
"from": {
"type": "string"
},
"op": {
"enum": [
"move"
],
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"from",
"path",
"op"
],
"title": "JsonPatchMove",
"type": "object"
},
"JsonPatchOperation": {
"discriminator": {
"mapping": {
"add": "#/components/schemas/JsonPatchAdd",
"copy": "#/components/schemas/JsonPatchCopy",
"move": "#/components/schemas/JsonPatchMove",
"remove": "#/components/schemas/JsonPatchRemove",
"replace": "#/components/schemas/JsonPatchReplace",
"test": "#/components/schemas/JsonPatchTest"
},
"propertyName": "op"
},
"oneOf": [
{
"$ref": "#/components/schemas/JsonPatchAdd"
},
{
"$ref": "#/components/schemas/JsonPatchCopy"
},
{
"$ref": "#/components/schemas/JsonPatchMove"
},
{
"$ref": "#/components/schemas/JsonPatchRemove"
},
{
"$ref": "#/components/schemas/JsonPatchReplace"
},
{
"$ref": "#/components/schemas/JsonPatchTest"
}
],
"title": "JsonPatchOperation"
},
"JsonPatchRemove": {
"properties": {
"old": {},
"op": {
"enum": [
"remove"
],
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"path",
"op"
],
"title": "JsonPatchRemove",
"type": "object"
},
"JsonPatchReplace": {
"properties": {
"old": {},
"op": {
"enum": [
"replace"
],
"type": "string"
},
"path": {
"type": "string"
},
"value": {}
},
"required": [
"path",
"value",
"op"
],
"title": "JsonPatchReplace",
"type": "object"
},
"JsonPatchTest": {
"properties": {
"op": {
"enum": [
"test"
],
"type": "string"
},
"path": {
"type": "string"
},
"value": {}
},
"required": [
"path",
"value",
"op"
],
"title": "JsonPatchTest",
"type": "object"
},
"KickUserRequest": {
"properties": {
"userId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"userId"
],
"title": "KickUserRequest",
"type": "object"
},
"LinearIntegrationSummary": {
"properties": {
"capabilities": {
"$ref": "#/components/schemas/IntegrationCapabilities"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"lastSyncAt": {
"format": "date-time",
"type": "string"
},
"lastSyncState": {
"$ref": "#/components/schemas/IntegrationSyncState"
},
"settings": {
"$ref": "#/components/schemas/LinearIntegrationTypeSettings"
},
"typeId": {
"const": "linear",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"createdAt",
"capabilities",
"enabled"
],
"title": "LinearIntegrationSummary",
"type": "object"
},
"LinearIntegrationTypeSettings": {
"properties": {
"autoSync": {
"type": "boolean"
},
"mappings": {
"default": [],
"items": {
"$ref": "#/components/schemas/MappingSettingsIntegrationMappingSettings"
},
"type": "array"
},
"removeExtraneous": {
"type": "boolean"
},
"secrets": {
"$ref": "#/components/schemas/IntegrationSecrets"
},
"selectItemType": {
"$ref": "#/components/schemas/LinearItemLinearItemType"
},
"selectLabels": {
"items": {
"type": "string"
},
"type": "array"
},
"selectTeam": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"removeExtraneous",
"autoSync"
],
"title": "LinearIntegrationTypeSettings",
"type": "object"
},
"LinearItemLinearItemType": {
"enum": [
"Initiative",
"Issue",
"Project"
],
"title": "LinearItemLinearItemType",
"type": "string"
},
"ListViewTypeSettings": {
"properties": {
"groupBy": {
"default": [],
"items": {
"$ref": "#/components/schemas/GroupBy"
},
"type": "array"
},
"showAlias": {
"default": false,
"type": "boolean"
},
"showAssignees": {
"default": false,
"type": "boolean"
},
"showChildItems": {
"default": true,
"type": "boolean"
},
"showFieldIds": {
"default": [],
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"showFieldTypes": {
"default": [],
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"showIntegrations": {
"default": false,
"type": "boolean"
},
"showParentItems": {
"default": false,
"type": "boolean"
},
"showProgress": {
"default": true,
"type": "boolean"
},
"showStatus": {
"default": true,
"type": "boolean"
}
},
"title": "ListViewTypeSettings",
"type": "object"
},
"ListViewWithViewEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/ViewEmbed"
},
"description": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isPrivate": {
"type": "boolean"
},
"itemFilter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"itemScopeLimit": {
"$ref": "#/components/schemas/ItemScopeLimit"
},
"itemSort": {
"items": {
"$ref": "#/components/schemas/ItemSearchQuerySort"
},
"type": "array"
},
"name": {
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"pinnedToPosition": {
"format": "int32",
"type": "integer"
},
"settings": {
"$ref": "#/components/schemas/ListViewTypeSettings"
},
"typeId": {
"const": "list",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"typeId",
"settings",
"name",
"description",
"itemSort",
"order",
"isPrivate",
"_embedded"
],
"title": "ListViewWithViewEmbed",
"type": "object"
},
"MappingDirection": {
"description": "The direction in which mapped values are written.",
"enum": [
"both",
"toInternalOnce",
"toExternal",
"toInternal"
],
"title": "MappingDirection",
"type": "string"
},
"MappingSettingsAirfocusMappingSettings": {
"discriminator": {
"mapping": {
"simple": "#/components/schemas/MappingSettingsAirfocusMappingSettingsSimple",
"withOptions": "#/components/schemas/MappingSettingsAirfocusMappingSettingsWithOptions"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/MappingSettingsAirfocusMappingSettingsSimple"
},
{
"$ref": "#/components/schemas/MappingSettingsAirfocusMappingSettingsWithOptions"
}
],
"title": "MappingSettingsAirfocusMappingSettings"
},
"MappingSettingsAirfocusMappingSettingsOptionPair": {
"properties": {
"externalId": {
"type": "string"
},
"internalId": {
"type": "string"
}
},
"required": [
"internalId",
"externalId"
],
"title": "MappingSettingsAirfocusMappingSettingsOptionPair",
"type": "object"
},
"MappingSettingsAirfocusMappingSettingsSimple": {
"properties": {
"direction": {
"$ref": "#/components/schemas/MappingDirection"
},
"externalId": {
"$ref": "#/components/schemas/RefItemProperty"
},
"internalId": {
"$ref": "#/components/schemas/RefItemProperty"
},
"type": {
"const": "simple",
"type": "string"
}
},
"required": [
"internalId",
"externalId",
"direction",
"type"
],
"title": "MappingSettingsAirfocusMappingSettingsSimple",
"type": "object"
},
"MappingSettingsAirfocusMappingSettingsWithOptions": {
"properties": {
"direction": {
"$ref": "#/components/schemas/MappingDirection"
},
"enableAutoCreateOptionsExternal": {
"type": "boolean"
},
"enableAutoCreateOptionsInternal": {
"type": "boolean"
},
"enableAutoMapping": {
"type": "boolean"
},
"externalId": {
"$ref": "#/components/schemas/RefItemProperty"
},
"internalId": {
"$ref": "#/components/schemas/RefItemProperty"
},
"pairs": {
"items": {
"$ref": "#/components/schemas/MappingSettingsAirfocusMappingSettingsOptionPair"
},
"type": "array"
},
"type": {
"const": "withOptions",
"type": "string"
}
},
"required": [
"internalId",
"externalId",
"direction",
"pairs",
"enableAutoMapping",
"enableAutoCreateOptionsInternal",
"enableAutoCreateOptionsExternal",
"type"
],
"title": "MappingSettingsAirfocusMappingSettingsWithOptions",
"type": "object"
},
"MappingSettingsIntegrationItemAssociationMappingSettings": {
"properties": {
"direction": {
"$ref": "#/components/schemas/MappingDirection"
},
"externalId": {
"type": "string"
},
"internalId": {
"type": "string"
},
"invertMapping": {
"type": "boolean"
}
},
"required": [
"internalId",
"externalId",
"direction",
"invertMapping"
],
"title": "MappingSettingsIntegrationItemAssociationMappingSettings",
"type": "object"
},
"MappingSettingsIntegrationMappingSettings": {
"discriminator": {
"mapping": {
"simple": "#/components/schemas/MappingSettingsIntegrationMappingSettingsSimple",
"withOptions": "#/components/schemas/MappingSettingsIntegrationMappingSettingsWithOptions"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/MappingSettingsIntegrationMappingSettingsSimple"
},
{
"$ref": "#/components/schemas/MappingSettingsIntegrationMappingSettingsWithOptions"
}
],
"title": "MappingSettingsIntegrationMappingSettings"
},
"MappingSettingsIntegrationMappingSettingsSimple": {
"properties": {
"direction": {
"$ref": "#/components/schemas/MappingDirection"
},
"externalId": {
"type": "string"
},
"internalId": {
"$ref": "#/components/schemas/RefItemProperty"
},
"type": {
"const": "simple",
"type": "string"
}
},
"required": [
"internalId",
"externalId",
"direction",
"type"
],
"title": "MappingSettingsIntegrationMappingSettingsSimple",
"type": "object"
},
"MappingSettingsIntegrationMappingSettingsWithOptions": {
"properties": {
"addToExternal": {
"type": "string"
},
"direction": {
"$ref": "#/components/schemas/MappingDirection"
},
"enableAutoCreateOptionsExternal": {
"type": "boolean"
},
"enableAutoCreateOptionsInternal": {
"type": "boolean"
},
"enableAutoMapping": {
"type": "boolean"
},
"externalId": {
"type": "string"
},
"internalId": {
"$ref": "#/components/schemas/RefItemProperty"
},
"pairs": {
"items": {
"$ref": "#/components/schemas/MappingSettingsIntegrationMappingSettingsWithOptionsOptionPair"
},
"type": "array"
},
"type": {
"const": "withOptions",
"type": "string"
}
},
"required": [
"internalId",
"externalId",
"direction",
"pairs",
"enableAutoMapping",
"enableAutoCreateOptionsInternal",
"enableAutoCreateOptionsExternal",
"type"
],
"title": "MappingSettingsIntegrationMappingSettingsWithOptions",
"type": "object"
},
"MappingSettingsIntegrationMappingSettingsWithOptionsOptionPair": {
"properties": {
"externalId": {
"type": "string"
},
"internalId": {
"type": "string"
}
},
"required": [
"externalId"
],
"title": "MappingSettingsIntegrationMappingSettingsWithOptionsOptionPair",
"type": "object"
},
"Milestone": {
"properties": {
"color": {
"$ref": "#/components/schemas/SelectFieldOptionColor",
"description": "Optional color of the milestone."
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"date": {
"description": "Date of the milestone. It's optional, assuming that a milestone can be pre-created before the actual date is known.",
"format": "date",
"type": "string"
},
"description": {
"description": "Description of the milestone.",
"type": "string"
},
"icon": {
"$ref": "#/components/schemas/MilestoneIcon"
},
"id": {
"description": "Unique identifier of the milestone.",
"format": "uuid",
"type": "string"
},
"name": {
"description": "Name of the milestone.",
"type": "string"
},
"timezone": {
"description": "Optional timezone of the milestone date.",
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"createdAt"
],
"title": "Milestone",
"type": "object"
},
"MilestoneBulkAction": {
"discriminator": {
"mapping": {
"create": "#/components/schemas/MilestoneBulkCreate",
"delete": "#/components/schemas/MilestoneBulkDelete",
"patch": "#/components/schemas/MilestoneBulkPatch",
"update": "#/components/schemas/MilestoneBulkUpdate"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/MilestoneBulkCreate"
},
{
"$ref": "#/components/schemas/MilestoneBulkDelete"
},
{
"$ref": "#/components/schemas/MilestoneBulkPatch"
},
{
"$ref": "#/components/schemas/MilestoneBulkUpdate"
}
],
"title": "MilestoneBulkAction"
},
"MilestoneBulkCreate": {
"properties": {
"resource": {
"$ref": "#/components/schemas/CreateMilestoneRequest"
},
"type": {
"enum": [
"create"
],
"type": "string"
}
},
"required": [
"resource",
"type"
],
"title": "MilestoneBulkCreate",
"type": "object"
},
"MilestoneBulkDelete": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"type": {
"enum": [
"delete"
],
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "MilestoneBulkDelete",
"type": "object"
},
"MilestoneBulkPatch": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"transform": {
"$ref": "#/components/schemas/JsonPatch"
},
"type": {
"enum": [
"patch"
],
"type": "string"
}
},
"required": [
"id",
"transform",
"type"
],
"title": "MilestoneBulkPatch",
"type": "object"
},
"MilestoneBulkUpdate": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/UpdateMilestoneRequest"
},
"type": {
"enum": [
"update"
],
"type": "string"
}
},
"required": [
"id",
"resource",
"type"
],
"title": "MilestoneBulkUpdate",
"type": "object"
},
"MilestoneField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/MilestoneFieldTypeSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "milestone",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "MilestoneField",
"type": "object"
},
"MilestoneFieldFilter": {
"discriminator": {
"mapping": {
"after": "#/components/schemas/MilestoneFieldFilterAfter",
"afterOrOn": "#/components/schemas/MilestoneFieldFilterAfterOrOn",
"before": "#/components/schemas/MilestoneFieldFilterBefore",
"beforeOrOn": "#/components/schemas/MilestoneFieldFilterBeforeOrOn",
"containsAll": "#/components/schemas/MilestoneFieldFilterContainsAll",
"containsAny": "#/components/schemas/MilestoneFieldFilterContainsAny",
"defined": "#/components/schemas/MilestoneFieldFilterDefined",
"range": "#/components/schemas/MilestoneFieldFilterRange",
"relative": "#/components/schemas/MilestoneFieldFilterRelative"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/MilestoneFieldFilterAfter"
},
{
"$ref": "#/components/schemas/MilestoneFieldFilterAfterOrOn"
},
{
"$ref": "#/components/schemas/MilestoneFieldFilterBefore"
},
{
"$ref": "#/components/schemas/MilestoneFieldFilterBeforeOrOn"
},
{
"$ref": "#/components/schemas/MilestoneFieldFilterContainsAll"
},
{
"$ref": "#/components/schemas/MilestoneFieldFilterContainsAny"
},
{
"$ref": "#/components/schemas/MilestoneFieldFilterDefined"
},
{
"$ref": "#/components/schemas/MilestoneFieldFilterRange"
},
{
"$ref": "#/components/schemas/MilestoneFieldFilterRelative"
}
],
"title": "MilestoneFieldFilter"
},
"MilestoneFieldFilterAfter": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"type": {
"const": "after",
"type": "string"
}
},
"required": [
"date",
"type"
],
"title": "MilestoneFieldFilterAfter",
"type": "object"
},
"MilestoneFieldFilterAfterOrOn": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"type": {
"const": "afterOrOn",
"type": "string"
}
},
"required": [
"date",
"type"
],
"title": "MilestoneFieldFilterAfterOrOn",
"type": "object"
},
"MilestoneFieldFilterBefore": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"type": {
"const": "before",
"type": "string"
}
},
"required": [
"date",
"type"
],
"title": "MilestoneFieldFilterBefore",
"type": "object"
},
"MilestoneFieldFilterBeforeOrOn": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"type": {
"const": "beforeOrOn",
"type": "string"
}
},
"required": [
"date",
"type"
],
"title": "MilestoneFieldFilterBeforeOrOn",
"type": "object"
},
"MilestoneFieldFilterContainsAll": {
"properties": {
"ids": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"type": {
"const": "containsAll",
"type": "string"
}
},
"required": [
"ids",
"type"
],
"title": "MilestoneFieldFilterContainsAll",
"type": "object"
},
"MilestoneFieldFilterContainsAny": {
"properties": {
"ids": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"type": {
"const": "containsAny",
"type": "string"
}
},
"required": [
"ids",
"type"
],
"title": "MilestoneFieldFilterContainsAny",
"type": "object"
},
"MilestoneFieldFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "MilestoneFieldFilterDefined",
"type": "object"
},
"MilestoneFieldFilterRange": {
"properties": {
"from": {
"format": "date",
"type": "string"
},
"type": {
"const": "range",
"type": "string"
},
"until": {
"format": "date",
"type": "string"
}
},
"required": [
"from",
"until",
"type"
],
"title": "MilestoneFieldFilterRange",
"type": "object"
},
"MilestoneFieldFilterRelative": {
"properties": {
"anchor": {
"$ref": "#/components/schemas/ItemSearchQueryTimeAnchor"
},
"type": {
"const": "relative",
"type": "string"
}
},
"required": [
"anchor",
"type"
],
"title": "MilestoneFieldFilterRelative",
"type": "object"
},
"MilestoneFieldTypeSettings": {
"properties": {
"milestones": {
"description": "List of predefined milestones available for selection.",
"items": {
"$ref": "#/components/schemas/Milestone"
},
"type": "array"
},
"multi": {
"description": "Indicates whether multiple milestones can be selected per item.",
"type": "boolean"
}
},
"required": [
"milestones",
"multi"
],
"title": "MilestoneFieldTypeSettings",
"type": "object"
},
"MilestoneFieldValue": {
"properties": {
"milestoneIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"milestoneIds"
],
"title": "MilestoneFieldValue",
"type": "object"
},
"MilestoneFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/MilestoneFieldTypeSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "milestone",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "MilestoneFieldWithFieldEmbed",
"type": "object"
},
"MilestoneIcon": {
"description": "Optional icon of the milestone.",
"enum": [
"circle",
"diamond",
"hexagon",
"pentagon",
"square",
"triangle"
],
"title": "MilestoneIcon",
"type": "string"
},
"MilestoneWithEmbed": {
"properties": {
"_embedded": {
"type": "object"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"date": {
"format": "date",
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"lastUpdatedAt": {
"format": "date-time",
"type": "string"
},
"name": {
"type": "string"
},
"timezone": {
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"name",
"description",
"date",
"createdAt",
"lastUpdatedAt",
"_embedded"
],
"title": "MilestoneWithEmbed",
"type": "object"
},
"MilestoneWithEmbedOrNullList": {
"items": {
"$ref": "#/components/schemas/MilestoneWithEmbed"
},
"title": "MilestoneWithEmbedOrNullList",
"type": "array"
},
"MilestoneWithEmbedPage": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/MilestoneWithEmbed"
},
"type": "array"
},
"totalItems": {
"format": "int32",
"type": "integer"
}
},
"required": [
"items",
"totalItems"
],
"title": "MilestoneWithEmbedPage",
"type": "object"
},
"MirrorApp": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/MirrorAppTypeSettings"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "mirror",
"type": "string"
}
},
"required": [
"id",
"teamId",
"typeId",
"settings"
],
"title": "MirrorApp",
"type": "object"
},
"MirrorAppTypeSettings": {
"properties": {
"mirrorFieldId": {
"format": "uuid",
"type": "string"
},
"prioritizationFieldId": {
"format": "uuid",
"type": "string"
},
"sources": {
"items": {
"$ref": "#/components/schemas/MirrorAppTypeSettingsSource"
},
"type": "array"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"workspaceId",
"mirrorFieldId",
"sources"
],
"title": "MirrorAppTypeSettings",
"type": "object"
},
"MirrorAppTypeSettingsSource": {
"properties": {
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"mapping": {
"items": {
"$ref": "#/components/schemas/MappingSettingsAirfocusMappingSettings"
},
"type": "array"
},
"mirrorFieldId": {
"format": "uuid",
"type": "string"
},
"prioritizationFieldId": {
"format": "uuid",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"workspaceId",
"mirrorFieldId",
"mapping"
],
"title": "MirrorAppTypeSettingsSource",
"type": "object"
},
"MirrorSourceField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "mirror-source",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "MirrorSourceField",
"type": "object"
},
"MirrorSourceFieldTypeFilter": {
"discriminator": {
"mapping": {
"defined": "#/components/schemas/MirrorSourceFieldTypeFilterDefined"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/MirrorSourceFieldTypeFilterDefined"
}
],
"title": "MirrorSourceFieldTypeFilter"
},
"MirrorSourceFieldTypeFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "MirrorSourceFieldTypeFilterDefined",
"type": "object"
},
"MirrorSourceFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "mirror-source",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "MirrorSourceFieldWithFieldEmbed",
"type": "object"
},
"MirrorTargetField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "mirror-target",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "MirrorTargetField",
"type": "object"
},
"MirrorTargetFieldTypeFilter": {
"discriminator": {
"mapping": {
"defined": "#/components/schemas/MirrorTargetFieldTypeFilterDefined"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/MirrorTargetFieldTypeFilterDefined"
}
],
"title": "MirrorTargetFieldTypeFilter"
},
"MirrorTargetFieldTypeFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "MirrorTargetFieldTypeFilterDefined",
"type": "object"
},
"MirrorTargetFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "mirror-target",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "MirrorTargetFieldWithFieldEmbed",
"type": "object"
},
"NotificationSettingUpdateRequest": {
"properties": {
"settings": {
"$ref": "#/components/schemas/NotificationSettingsData"
}
},
"required": [
"settings"
],
"title": "NotificationSettingUpdateRequest",
"type": "object"
},
"NotificationSettings": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"lastUpdatedAt": {
"format": "date-time",
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/NotificationSettingsData"
},
"userId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"userId",
"settings",
"createdAt",
"lastUpdatedAt"
],
"title": "NotificationSettings",
"type": "object"
},
"NotificationSettingsData": {
"properties": {
"enableAgentNotifications": {
"default": true,
"type": "boolean"
},
"sendEmailNotifications": {
"default": false,
"type": "boolean"
}
},
"title": "NotificationSettingsData",
"type": "object"
},
"NumberField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/NumberFieldTypeSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "number",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "NumberField",
"type": "object"
},
"NumberFieldTypeLikeFilter": {
"discriminator": {
"mapping": {
"defined": "#/components/schemas/NumberFieldTypeLikeFilterDefined",
"equal": "#/components/schemas/NumberFieldTypeLikeFilterEqual",
"greaterThan": "#/components/schemas/NumberFieldTypeLikeFilterGreaterThan",
"greaterThanOrEqual": "#/components/schemas/NumberFieldTypeLikeFilterGreaterThanOrEqual",
"lessThan": "#/components/schemas/NumberFieldTypeLikeFilterLessThan",
"lessThanOrEqual": "#/components/schemas/NumberFieldTypeLikeFilterLessThanOrEqual"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/NumberFieldTypeLikeFilterDefined"
},
{
"$ref": "#/components/schemas/NumberFieldTypeLikeFilterEqual"
},
{
"$ref": "#/components/schemas/NumberFieldTypeLikeFilterGreaterThan"
},
{
"$ref": "#/components/schemas/NumberFieldTypeLikeFilterGreaterThanOrEqual"
},
{
"$ref": "#/components/schemas/NumberFieldTypeLikeFilterLessThan"
},
{
"$ref": "#/components/schemas/NumberFieldTypeLikeFilterLessThanOrEqual"
}
],
"title": "NumberFieldTypeLikeFilter"
},
"NumberFieldTypeLikeFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "NumberFieldTypeLikeFilterDefined",
"type": "object"
},
"NumberFieldTypeLikeFilterEqual": {
"properties": {
"number": {
"type": "number"
},
"type": {
"const": "equal",
"type": "string"
}
},
"required": [
"number",
"type"
],
"title": "NumberFieldTypeLikeFilterEqual",
"type": "object"
},
"NumberFieldTypeLikeFilterGreaterThan": {
"properties": {
"number": {
"type": "number"
},
"type": {
"const": "greaterThan",
"type": "string"
}
},
"required": [
"number",
"type"
],
"title": "NumberFieldTypeLikeFilterGreaterThan",
"type": "object"
},
"NumberFieldTypeLikeFilterGreaterThanOrEqual": {
"properties": {
"number": {
"type": "number"
},
"type": {
"const": "greaterThanOrEqual",
"type": "string"
}
},
"required": [
"number",
"type"
],
"title": "NumberFieldTypeLikeFilterGreaterThanOrEqual",
"type": "object"
},
"NumberFieldTypeLikeFilterLessThan": {
"properties": {
"number": {
"type": "number"
},
"type": {
"const": "lessThan",
"type": "string"
}
},
"required": [
"number",
"type"
],
"title": "NumberFieldTypeLikeFilterLessThan",
"type": "object"
},
"NumberFieldTypeLikeFilterLessThanOrEqual": {
"properties": {
"number": {
"type": "number"
},
"type": {
"const": "lessThanOrEqual",
"type": "string"
}
},
"required": [
"number",
"type"
],
"title": "NumberFieldTypeLikeFilterLessThanOrEqual",
"type": "object"
},
"NumberFieldTypeSettings": {
"properties": {
"maximum": {
"type": "number"
},
"minimum": {
"type": "number"
},
"overflow": {
"type": "boolean"
},
"stepping": {
"$ref": "#/components/schemas/NumberFieldTypeSettingsStepping"
},
"unit": {
"$ref": "#/components/schemas/NumberFieldTypeSettingsUnit"
}
},
"required": [
"overflow"
],
"title": "NumberFieldTypeSettings",
"type": "object"
},
"NumberFieldTypeSettingsStepping": {
"discriminator": {
"mapping": {
"equal": "#/components/schemas/NumberFieldTypeSettingsSteppingEqual",
"exponential": "#/components/schemas/NumberFieldTypeSettingsSteppingExponential",
"fibonacci": "#/components/schemas/NumberFieldTypeSettingsSteppingFibonacci"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/NumberFieldTypeSettingsSteppingEqual"
},
{
"$ref": "#/components/schemas/NumberFieldTypeSettingsSteppingExponential"
},
{
"$ref": "#/components/schemas/NumberFieldTypeSettingsSteppingFibonacci"
}
],
"title": "NumberFieldTypeSettingsStepping"
},
"NumberFieldTypeSettingsSteppingEqual": {
"properties": {
"delta": {
"type": "number"
},
"type": {
"const": "equal",
"type": "string"
}
},
"required": [
"delta",
"type"
],
"title": "NumberFieldTypeSettingsSteppingEqual",
"type": "object"
},
"NumberFieldTypeSettingsSteppingExponential": {
"properties": {
"factor": {
"type": "number"
},
"type": {
"const": "exponential",
"type": "string"
}
},
"required": [
"factor",
"type"
],
"title": "NumberFieldTypeSettingsSteppingExponential",
"type": "object"
},
"NumberFieldTypeSettingsSteppingFibonacci": {
"properties": {
"type": {
"const": "fibonacci",
"type": "string"
}
},
"required": [
"type"
],
"title": "NumberFieldTypeSettingsSteppingFibonacci",
"type": "object"
},
"NumberFieldTypeSettingsUnit": {
"discriminator": {
"mapping": {
"custom": "#/components/schemas/NumberFieldTypeSettingsUnitCustom",
"money": "#/components/schemas/NumberFieldTypeSettingsUnitMoney",
"percent": "#/components/schemas/NumberFieldTypeSettingsUnitPercent",
"storyPoints": "#/components/schemas/NumberFieldTypeSettingsUnitStoryPoints"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/NumberFieldTypeSettingsUnitCustom"
},
{
"$ref": "#/components/schemas/NumberFieldTypeSettingsUnitMoney"
},
{
"$ref": "#/components/schemas/NumberFieldTypeSettingsUnitPercent"
},
{
"$ref": "#/components/schemas/NumberFieldTypeSettingsUnitStoryPoints"
}
],
"title": "NumberFieldTypeSettingsUnit"
},
"NumberFieldTypeSettingsUnitCustom": {
"properties": {
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
},
"type": {
"const": "custom",
"type": "string"
}
},
"required": [
"prefix",
"suffix",
"type"
],
"title": "NumberFieldTypeSettingsUnitCustom",
"type": "object"
},
"NumberFieldTypeSettingsUnitMoney": {
"properties": {
"currency": {
"type": "string"
},
"type": {
"const": "money",
"type": "string"
}
},
"required": [
"currency",
"type"
],
"title": "NumberFieldTypeSettingsUnitMoney",
"type": "object"
},
"NumberFieldTypeSettingsUnitPercent": {
"properties": {
"type": {
"const": "percent",
"type": "string"
}
},
"required": [
"type"
],
"title": "NumberFieldTypeSettingsUnitPercent",
"type": "object"
},
"NumberFieldTypeSettingsUnitStoryPoints": {
"properties": {
"type": {
"const": "storyPoints",
"type": "string"
}
},
"required": [
"type"
],
"title": "NumberFieldTypeSettingsUnitStoryPoints",
"type": "object"
},
"NumberFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/NumberFieldTypeSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "number",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "NumberFieldWithFieldEmbed",
"type": "object"
},
"NumberWidget": {
"properties": {
"dataSettings": {
"$ref": "#/components/schemas/NumberWidgetDataSettings"
},
"displaySettings": {
"$ref": "#/components/schemas/NumberWidgetDisplaySettings"
},
"id": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"const": "number",
"type": "string"
}
},
"required": [
"id",
"title",
"dataSettings",
"displaySettings",
"type"
],
"title": "NumberWidget",
"type": "object"
},
"NumberWidgetDataSettings": {
"properties": {
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"numberType": {
"type": "string"
},
"period": {
"$ref": "#/components/schemas/WidgetPeriod"
}
},
"required": [
"numberType"
],
"title": "NumberWidgetDataSettings",
"type": "object"
},
"NumberWidgetDisplaySettings": {
"properties": {
"showLabel": {
"type": "boolean"
}
},
"required": [
"showLabel"
],
"title": "NumberWidgetDisplaySettings",
"type": "object"
},
"ObjectiveWidget": {
"properties": {
"dataSettings": {
"$ref": "#/components/schemas/ObjectiveWidgetDataSettings"
},
"displaySettings": {
"$ref": "#/components/schemas/ObjectiveWidgetDisplaySettings"
},
"id": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"const": "objective",
"type": "string"
}
},
"required": [
"id",
"title",
"dataSettings",
"displaySettings",
"type"
],
"title": "ObjectiveWidget",
"type": "object"
},
"ObjectiveWidgetDataSettings": {
"properties": {
"confidenceLevels": {
"items": {
"$ref": "#/components/schemas/Confidence"
},
"type": "array"
},
"value": {
"$ref": "#/components/schemas/ObjectiveWidgetDataSettingsValue"
}
},
"required": [
"value"
],
"title": "ObjectiveWidgetDataSettings",
"type": "object"
},
"ObjectiveWidgetDataSettingsValue": {
"enum": [
"keyResults",
"objective"
],
"title": "ObjectiveWidgetDataSettingsValue",
"type": "string"
},
"ObjectiveWidgetDisplaySettings": {
"properties": {
"layout": {
"$ref": "#/components/schemas/ObjectiveWidgetDisplaySettingsLayout"
},
"showConfidence": {
"type": "boolean"
},
"showLinkedItems": {
"type": "boolean"
},
"showProgress": {
"type": "boolean"
},
"showTimePeriod": {
"type": "boolean"
}
},
"required": [
"layout",
"showProgress",
"showConfidence",
"showTimePeriod",
"showLinkedItems"
],
"title": "ObjectiveWidgetDisplaySettings",
"type": "object"
},
"ObjectiveWidgetDisplaySettingsLayout": {
"enum": [
"card",
"list"
],
"title": "ObjectiveWidgetDisplaySettingsLayout",
"type": "string"
},
"OkrApp": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/OkrAppTypeSettings"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "okr",
"type": "string"
}
},
"required": [
"id",
"teamId",
"typeId",
"settings"
],
"title": "OkrApp",
"type": "object"
},
"OkrAppTypeSettings": {
"properties": {
"confidence": {
"$ref": "#/components/schemas/OkrConfidenceFieldSettings"
},
"hierarchy": {
"$ref": "#/components/schemas/OkrAppTypeSettingsHierarchyNode"
},
"linkedWorkspaces": {
"additionalProperties": {
"$ref": "#/components/schemas/OkrAppTypeSettingsLinkedWorkspaceSettings"
},
"type": "object"
},
"objectiveWorkspaces": {
"additionalProperties": {
"$ref": "#/components/schemas/OkrAppTypeSettingsObjectiveWorkspaceSettings"
},
"type": "object"
},
"timePeriods": {
"$ref": "#/components/schemas/OkrTimePeriodFieldSettings"
}
},
"required": [
"objectiveWorkspaces",
"linkedWorkspaces",
"timePeriods",
"confidence"
],
"title": "OkrAppTypeSettings",
"type": "object"
},
"OkrAppTypeSettingsHierarchyNode": {
"properties": {
"children": {
"items": {
"$ref": "#/components/schemas/OkrAppTypeSettingsHierarchyNode"
},
"type": "array"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"workspaceId",
"children"
],
"title": "OkrAppTypeSettingsHierarchyNode",
"type": "object"
},
"OkrAppTypeSettingsLinkedWorkspaceSettings": {
"properties": {
"keyResultReferenceFieldId": {
"format": "uuid",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"workspaceId",
"keyResultReferenceFieldId"
],
"title": "OkrAppTypeSettingsLinkedWorkspaceSettings",
"type": "object"
},
"OkrAppTypeSettingsObjectiveWorkspaceSettings": {
"properties": {
"cascadePermissions": {
"type": "boolean"
},
"checkinsFieldId": {
"format": "uuid",
"type": "string"
},
"confidenceFieldId": {
"format": "uuid",
"type": "string"
},
"keyResultsFieldId": {
"format": "uuid",
"type": "string"
},
"linkedWorkspaceIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"progressFieldId": {
"format": "uuid",
"type": "string"
},
"timePeriodFieldId": {
"format": "uuid",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"workspaceId",
"linkedWorkspaceIds",
"checkinsFieldId",
"confidenceFieldId",
"keyResultsFieldId",
"progressFieldId",
"timePeriodFieldId",
"cascadePermissions"
],
"title": "OkrAppTypeSettingsObjectiveWorkspaceSettings",
"type": "object"
},
"OkrCheckinsField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "okr-checkins",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "OkrCheckinsField",
"type": "object"
},
"OkrCheckinsFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "okr-checkins",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "OkrCheckinsFieldWithFieldEmbed",
"type": "object"
},
"OkrConfidenceField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/OkrConfidenceFieldSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "okr-confidence",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "OkrConfidenceField",
"type": "object"
},
"OkrConfidenceFieldFilter": {
"discriminator": {
"mapping": {
"containsAny": "#/components/schemas/OkrConfidenceFieldFilterContainsAny",
"defined": "#/components/schemas/OkrConfidenceFieldFilterDefined"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/OkrConfidenceFieldFilterContainsAny"
},
{
"$ref": "#/components/schemas/OkrConfidenceFieldFilterDefined"
}
],
"title": "OkrConfidenceFieldFilter"
},
"OkrConfidenceFieldFilterContainsAny": {
"properties": {
"type": {
"const": "containsAny",
"type": "string"
},
"values": {
"items": {
"$ref": "#/components/schemas/Confidence"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"values",
"type"
],
"title": "OkrConfidenceFieldFilterContainsAny",
"type": "object"
},
"OkrConfidenceFieldFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "OkrConfidenceFieldFilterDefined",
"type": "object"
},
"OkrConfidenceFieldSettings": {
"properties": {
"low": {
"format": "int32",
"type": "integer"
},
"medium": {
"format": "int32",
"type": "integer"
}
},
"required": [
"low",
"medium"
],
"title": "OkrConfidenceFieldSettings",
"type": "object"
},
"OkrConfidenceFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/OkrConfidenceFieldSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "okr-confidence",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "OkrConfidenceFieldWithFieldEmbed",
"type": "object"
},
"OkrKeyResultReferenceField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "okr-key-result-reference",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "OkrKeyResultReferenceField",
"type": "object"
},
"OkrKeyResultReferenceFieldFilter": {
"discriminator": {
"mapping": {
"containsAnyKeyResult": "#/components/schemas/OkrKeyResultReferenceFieldFilterContainsAnyKeyResult",
"containsAnyObjective": "#/components/schemas/OkrKeyResultReferenceFieldFilterContainsAnyObjective",
"defined": "#/components/schemas/OkrKeyResultReferenceFieldFilterDefined"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/OkrKeyResultReferenceFieldFilterContainsAnyKeyResult"
},
{
"$ref": "#/components/schemas/OkrKeyResultReferenceFieldFilterContainsAnyObjective"
},
{
"$ref": "#/components/schemas/OkrKeyResultReferenceFieldFilterDefined"
}
],
"title": "OkrKeyResultReferenceFieldFilter"
},
"OkrKeyResultReferenceFieldFilterContainsAnyKeyResult": {
"properties": {
"keyResultId": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"type": {
"const": "containsAnyKeyResult",
"type": "string"
}
},
"required": [
"keyResultId",
"type"
],
"title": "OkrKeyResultReferenceFieldFilterContainsAnyKeyResult",
"type": "object"
},
"OkrKeyResultReferenceFieldFilterContainsAnyObjective": {
"properties": {
"objectiveItemId": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"type": {
"const": "containsAnyObjective",
"type": "string"
}
},
"required": [
"objectiveItemId",
"type"
],
"title": "OkrKeyResultReferenceFieldFilterContainsAnyObjective",
"type": "object"
},
"OkrKeyResultReferenceFieldFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "OkrKeyResultReferenceFieldFilterDefined",
"type": "object"
},
"OkrKeyResultReferenceFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "okr-key-result-reference",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "OkrKeyResultReferenceFieldWithFieldEmbed",
"type": "object"
},
"OkrKeyResultsField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "okr-key-results",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "OkrKeyResultsField",
"type": "object"
},
"OkrKeyResultsFieldFilter": {
"discriminator": {
"mapping": {
"defined": "#/components/schemas/OkrKeyResultsFieldFilterDefined"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/OkrKeyResultsFieldFilterDefined"
}
],
"title": "OkrKeyResultsFieldFilter"
},
"OkrKeyResultsFieldFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "OkrKeyResultsFieldFilterDefined",
"type": "object"
},
"OkrKeyResultsFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "okr-key-results",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "OkrKeyResultsFieldWithFieldEmbed",
"type": "object"
},
"OkrProgressField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "okr-progress",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "OkrProgressField",
"type": "object"
},
"OkrProgressFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "okr-progress",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "OkrProgressFieldWithFieldEmbed",
"type": "object"
},
"OkrTimePeriodField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/OkrTimePeriodFieldSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "okr-time-period",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "OkrTimePeriodField",
"type": "object"
},
"OkrTimePeriodFieldSettings": {
"properties": {
"timePeriods": {
"items": {
"$ref": "#/components/schemas/TimePeriod"
},
"type": "array"
}
},
"required": [
"timePeriods"
],
"title": "OkrTimePeriodFieldSettings",
"type": "object"
},
"OkrTimePeriodFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/OkrTimePeriodFieldSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "okr-time-period",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "OkrTimePeriodFieldWithFieldEmbed",
"type": "object"
},
"PeopleField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/PeopleFieldTypeSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "people",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "PeopleField",
"type": "object"
},
"PeopleFieldTypeFilter": {
"discriminator": {
"mapping": {
"contain": "#/components/schemas/PeopleFieldTypeFilterContain",
"containsAll": "#/components/schemas/PeopleFieldTypeFilterContainsAll",
"containsAny": "#/components/schemas/PeopleFieldTypeFilterContainsAny",
"defined": "#/components/schemas/PeopleFieldTypeFilterDefined"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/PeopleFieldTypeFilterContain"
},
{
"$ref": "#/components/schemas/PeopleFieldTypeFilterContainsAll"
},
{
"$ref": "#/components/schemas/PeopleFieldTypeFilterContainsAny"
},
{
"$ref": "#/components/schemas/PeopleFieldTypeFilterDefined"
}
],
"title": "PeopleFieldTypeFilter"
},
"PeopleFieldTypeFilterContain": {
"properties": {
"type": {
"const": "contain",
"type": "string"
},
"user": {
"$ref": "#/components/schemas/UserRef"
}
},
"required": [
"user",
"type"
],
"title": "PeopleFieldTypeFilterContain",
"type": "object"
},
"PeopleFieldTypeFilterContainsAll": {
"properties": {
"type": {
"const": "containsAll",
"type": "string"
},
"users": {
"items": {
"$ref": "#/components/schemas/UserRef"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"users",
"type"
],
"title": "PeopleFieldTypeFilterContainsAll",
"type": "object"
},
"PeopleFieldTypeFilterContainsAny": {
"properties": {
"type": {
"const": "containsAny",
"type": "string"
},
"users": {
"items": {
"$ref": "#/components/schemas/UserRef"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"users",
"type"
],
"title": "PeopleFieldTypeFilterContainsAny",
"type": "object"
},
"PeopleFieldTypeFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "PeopleFieldTypeFilterDefined",
"type": "object"
},
"PeopleFieldTypeSettings": {
"properties": {
"autoAssign": {
"type": "boolean"
}
},
"required": [
"autoAssign"
],
"title": "PeopleFieldTypeSettings",
"type": "object"
},
"PeopleFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/PeopleFieldTypeSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "people",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "PeopleFieldWithFieldEmbed",
"type": "object"
},
"Permission": {
"enum": [
"comment",
"full",
"read",
"write"
],
"title": "Permission",
"type": "string"
},
"PlannerIntegrationSummary": {
"properties": {
"capabilities": {
"$ref": "#/components/schemas/IntegrationCapabilities"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"lastSyncAt": {
"format": "date-time",
"type": "string"
},
"lastSyncState": {
"$ref": "#/components/schemas/IntegrationSyncState"
},
"settings": {
"$ref": "#/components/schemas/PlannerIntegrationTypeSettings"
},
"typeId": {
"const": "planner",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"createdAt",
"capabilities",
"enabled"
],
"title": "PlannerIntegrationSummary",
"type": "object"
},
"PlannerIntegrationTypeSettings": {
"properties": {
"addLabel": {
"type": "string"
},
"autoSync": {
"type": "boolean"
},
"mapDateRangeField": {
"format": "uuid",
"type": "string"
},
"mapSelectFieldAndBucket": {
"$ref": "#/components/schemas/PlannerIntegrationTypeSettingsBucketMapping"
},
"mapSelectFieldAndLabels": {
"$ref": "#/components/schemas/PlannerIntegrationTypeSettingsLabelMapping"
},
"removeExtraneous": {
"type": "boolean"
},
"secrets": {
"$ref": "#/components/schemas/PlannerSettingsSecrets"
},
"selectGroup": {
"type": "string"
},
"selectLabels": {
"items": {
"type": "string"
},
"type": "array"
},
"selectPlan": {
"type": "string"
},
"title": {
"type": "string"
},
"twoWay": {
"default": false,
"type": "boolean"
}
},
"required": [
"removeExtraneous",
"autoSync"
],
"title": "PlannerIntegrationTypeSettings",
"type": "object"
},
"PlannerIntegrationTypeSettingsBucketMapping": {
"properties": {
"fieldId": {
"format": "uuid",
"type": "string"
},
"pairs": {
"items": {
"$ref": "#/components/schemas/PlannerIntegrationTypeSettingsBucketMappingPair"
},
"type": "array"
}
},
"required": [
"fieldId",
"pairs"
],
"title": "PlannerIntegrationTypeSettingsBucketMapping",
"type": "object"
},
"PlannerIntegrationTypeSettingsBucketMappingPair": {
"properties": {
"bucketId": {
"type": "string"
},
"optionId": {
"type": "string"
}
},
"required": [
"bucketId"
],
"title": "PlannerIntegrationTypeSettingsBucketMappingPair",
"type": "object"
},
"PlannerIntegrationTypeSettingsLabelMapping": {
"properties": {
"fieldId": {
"format": "uuid",
"type": "string"
},
"pairs": {
"items": {
"$ref": "#/components/schemas/PlannerIntegrationTypeSettingsLabelMappingPair"
},
"type": "array"
}
},
"required": [
"fieldId",
"pairs"
],
"title": "PlannerIntegrationTypeSettingsLabelMapping",
"type": "object"
},
"PlannerIntegrationTypeSettingsLabelMappingPair": {
"properties": {
"labelId": {
"type": "string"
},
"optionId": {
"type": "string"
}
},
"required": [
"optionId",
"labelId"
],
"title": "PlannerIntegrationTypeSettingsLabelMappingPair",
"type": "object"
},
"PlannerSettingsSecrets": {
"properties": {
"accessToken": {
"type": "string"
},
"expiration": {
"format": "date-time",
"type": "string"
},
"refreshToken": {
"type": "string"
}
},
"required": [
"accessToken",
"expiration",
"refreshToken"
],
"title": "PlannerSettingsSecrets",
"type": "object"
},
"PortalApp": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/PortalAppTypeSettings"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "portal",
"type": "string"
}
},
"required": [
"id",
"teamId",
"typeId",
"settings"
],
"title": "PortalApp",
"type": "object"
},
"PortalAppTypeSettings": {
"properties": {
"color": {
"type": "string"
},
"faviconImageId": {
"type": "string"
},
"logoImageId": {
"type": "string"
},
"name": {
"type": "string"
},
"ownerUserId": {
"format": "uuid",
"type": "string"
},
"pages": {
"items": {
"$ref": "#/components/schemas/PortalAppTypeSettingsPortalPage"
},
"type": "array"
},
"password": {
"type": "string"
},
"public": {
"type": "boolean"
},
"requireLogin": {
"type": "boolean"
},
"slug": {
"type": "string"
}
},
"required": [
"public",
"name",
"slug",
"ownerUserId",
"pages",
"requireLogin"
],
"title": "PortalAppTypeSettings",
"type": "object"
},
"PortalAppTypeSettingsPortalPage": {
"discriminator": {
"mapping": {
"url": "#/components/schemas/PortalAppTypeSettingsPortalPageUrlPage",
"workspace": "#/components/schemas/PortalAppTypeSettingsPortalPageWorkspacePage"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/PortalAppTypeSettingsPortalPageUrlPage"
},
{
"$ref": "#/components/schemas/PortalAppTypeSettingsPortalPageWorkspacePage"
}
],
"title": "PortalAppTypeSettingsPortalPage"
},
"PortalAppTypeSettingsPortalPageUrlPage": {
"properties": {
"public": {
"type": "boolean"
},
"title": {
"type": "string"
},
"type": {
"const": "url",
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"title",
"url",
"public",
"type"
],
"title": "PortalAppTypeSettingsPortalPageUrlPage",
"type": "object"
},
"PortalAppTypeSettingsPortalPageWorkspacePage": {
"properties": {
"fieldIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"heroDescription": {
"type": "string"
},
"heroTitle": {
"type": "string"
},
"metaDescription": {
"type": "string"
},
"metaTitle": {
"type": "string"
},
"portalFieldId": {
"format": "uuid",
"type": "string"
},
"public": {
"type": "boolean"
},
"searchIndex": {
"type": "boolean"
},
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"const": "workspace",
"type": "string"
},
"view": {
"$ref": "#/components/schemas/PortalAppTypeSettingsPortalView"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"slug",
"title",
"workspaceId",
"view",
"public",
"portalFieldId",
"fieldIds",
"searchIndex",
"type"
],
"title": "PortalAppTypeSettingsPortalPageWorkspacePage",
"type": "object"
},
"PortalAppTypeSettingsPortalView": {
"discriminator": {
"mapping": {
"grid": "#/components/schemas/PortalAppTypeSettingsPortalViewGridView"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/PortalAppTypeSettingsPortalViewGridView"
}
],
"title": "PortalAppTypeSettingsPortalView"
},
"PortalAppTypeSettingsPortalViewGridView": {
"properties": {
"publicFields": {
"default": [],
"items": {
"$ref": "#/components/schemas/PortalAppTypeSettingsPortalViewPortalField"
},
"type": "array",
"uniqueItems": true
},
"showFilters": {
"type": "boolean"
},
"swimlaneMode": {
"$ref": "#/components/schemas/SwimlaneMode"
},
"tabMode": {
"$ref": "#/components/schemas/SwimlaneMode"
},
"type": {
"const": "grid",
"type": "string"
}
},
"required": [
"type"
],
"title": "PortalAppTypeSettingsPortalViewGridView",
"type": "object"
},
"PortalAppTypeSettingsPortalViewPortalField": {
"discriminator": {
"mapping": {
"field": "#/components/schemas/PortalAppTypeSettingsPortalViewPortalFieldField",
"status": "#/components/schemas/PortalAppTypeSettingsPortalViewPortalFieldStatus",
"statusCategory": "#/components/schemas/PortalAppTypeSettingsPortalViewPortalFieldStatusCategory"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/PortalAppTypeSettingsPortalViewPortalFieldField"
},
{
"$ref": "#/components/schemas/PortalAppTypeSettingsPortalViewPortalFieldStatus"
},
{
"$ref": "#/components/schemas/PortalAppTypeSettingsPortalViewPortalFieldStatusCategory"
}
],
"title": "PortalAppTypeSettingsPortalViewPortalField"
},
"PortalAppTypeSettingsPortalViewPortalFieldField": {
"properties": {
"fieldId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "field",
"type": "string"
}
},
"required": [
"fieldId",
"type"
],
"title": "PortalAppTypeSettingsPortalViewPortalFieldField",
"type": "object"
},
"PortalAppTypeSettingsPortalViewPortalFieldStatus": {
"properties": {
"type": {
"const": "status",
"type": "string"
}
},
"required": [
"type"
],
"title": "PortalAppTypeSettingsPortalViewPortalFieldStatus",
"type": "object"
},
"PortalAppTypeSettingsPortalViewPortalFieldStatusCategory": {
"properties": {
"type": {
"const": "statusCategory",
"type": "string"
}
},
"required": [
"type"
],
"title": "PortalAppTypeSettingsPortalViewPortalFieldStatusCategory",
"type": "object"
},
"PortalField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "portal",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "PortalField",
"type": "object"
},
"PortalFieldTypeFilter": {
"discriminator": {
"mapping": {
"public": "#/components/schemas/PortalFieldTypeFilterPublic"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/PortalFieldTypeFilterPublic"
}
],
"title": "PortalFieldTypeFilter"
},
"PortalFieldTypeFilterPublic": {
"properties": {
"type": {
"const": "public",
"type": "string"
}
},
"required": [
"type"
],
"title": "PortalFieldTypeFilterPublic",
"type": "object"
},
"PortalFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "portal",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "PortalFieldWithFieldEmbed",
"type": "object"
},
"PortfolioApp": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/PortfolioAppSettings"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "portfolio",
"type": "string"
}
},
"required": [
"id",
"teamId",
"typeId",
"settings"
],
"title": "PortfolioApp",
"type": "object"
},
"PortfolioAppSettings": {
"properties": {
"globalFilter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"description": "An item-search filter to pull only specific items into this portfolio. This filter will be applied to all source workspaces, in addition to the filters defined for each source.",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"portfolioFieldId": {
"description": "Id of a team-field installed by this app in all the source workspaces, which contains links between source items and this portfolio.",
"format": "uuid",
"type": "string"
},
"sources": {
"description": "List of source workspaces with their corresponding settings, from where portfolio items should be pulled.",
"items": {
"$ref": "#/components/schemas/PortfolioAppSourceSettings"
},
"type": "array"
},
"workspaceId": {
"description": "Target workspace, where the portfolio will be configured.",
"format": "uuid",
"type": "string"
}
},
"required": [
"workspaceId",
"portfolioFieldId",
"sources"
],
"title": "PortfolioAppSettings",
"type": "object"
},
"PortfolioAppSourceSettings": {
"properties": {
"filter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"description": "An item-search filter to pull only specific items into this portfolio.",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"workspaceId": {
"description": "Id of the workspace, where the items should be pulled from.",
"format": "uuid",
"type": "string"
}
},
"required": [
"workspaceId"
],
"title": "PortfolioAppSourceSettings",
"type": "object"
},
"PortfolioSourceField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "portfolio-source",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "PortfolioSourceField",
"type": "object"
},
"PortfolioSourceFieldFilter": {
"discriminator": {
"mapping": {
"defined": "#/components/schemas/PortfolioSourceFieldFilterDefined"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/PortfolioSourceFieldFilterDefined"
}
],
"title": "PortfolioSourceFieldFilter"
},
"PortfolioSourceFieldFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "PortfolioSourceFieldFilterDefined",
"type": "object"
},
"PortfolioSourceFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "portfolio-source",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "PortfolioSourceFieldWithFieldEmbed",
"type": "object"
},
"PrioritizationApp": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/PrioritizationAppTypeConfiguration"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "prioritization",
"type": "string"
}
},
"required": [
"id",
"teamId",
"typeId",
"settings"
],
"title": "PrioritizationApp",
"type": "object"
},
"PrioritizationAppTypeConfiguration": {
"properties": {
"factors": {
"$ref": "#/components/schemas/Factors"
},
"mode": {
"$ref": "#/components/schemas/ScoringMode"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"workspaceId",
"factors",
"mode"
],
"title": "PrioritizationAppTypeConfiguration",
"type": "object"
},
"PrioritizationField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "prioritization",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "PrioritizationField",
"type": "object"
},
"PrioritizationFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "prioritization",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "PrioritizationFieldWithFieldEmbed",
"type": "object"
},
"ReconfigureFieldRequest": {
"properties": {
"description": {
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"description": "The settings object which corresponds to the type of the requested field, or it can be skipped if the requested field does not have any settings.\nThis schema shows all the available field-settings. See also the Field schema to learn about settings of each specific field type.",
"oneOf": [
{
"$ref": "#/components/schemas/FormSourceFieldTypeSettings"
},
{
"$ref": "#/components/schemas/InsightsFieldTypeSettings"
},
{
"$ref": "#/components/schemas/MilestoneFieldTypeSettings"
},
{
"$ref": "#/components/schemas/NumberFieldTypeSettings"
},
{
"$ref": "#/components/schemas/OkrConfidenceFieldSettings"
},
{
"$ref": "#/components/schemas/OkrTimePeriodFieldSettings"
},
{
"$ref": "#/components/schemas/PeopleFieldTypeSettings"
},
{
"$ref": "#/components/schemas/SelectFieldTypeSettings"
},
{
"$ref": "#/components/schemas/TimePeriodFieldSettings"
},
{
"$ref": "#/components/schemas/VotingAppScoreFieldTypeSettings"
}
]
}
},
"required": [
"name",
"description",
"isTeamField"
],
"title": "ReconfigureFieldRequest",
"type": "object"
},
"RefItemExtendedProperty": {
"oneOf": [
{
"enum": [
"archived",
"assignees",
"color",
"createdAt",
"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"
],
"type": "string"
},
{
"description": "A combination of 'fieldid:' prefix and a UUID field-id.",
"pattern": "^fieldid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"type": "string"
},
{
"description": "A combination of 'fieldtype:' prefix and a field type id.",
"pattern": "^fieldtype:.+$",
"type": "string"
}
],
"title": "RefItemExtendedProperty"
},
"RefItemProperty": {
"oneOf": [
{
"enum": [
"archived",
"assignees",
"color",
"createdAt",
"description",
"id",
"lastUpdatedAt",
"name",
"number",
"order",
"status",
"statusCategoryUpdatedAt",
"statusUpdatedAt",
"workspace"
],
"type": "string"
},
{
"description": "A combination of 'fieldid:' prefix and a UUID field-id.",
"pattern": "^fieldid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"type": "string"
}
],
"title": "RefItemProperty"
},
"RelativeItemInfo": {
"properties": {
"alias": {
"type": "string"
},
"childOrder": {
"format": "int32",
"type": "integer"
},
"item": {
"$ref": "#/components/schemas/Item"
},
"itemId": {
"format": "uuid",
"type": "string"
},
"itemType": {
"$ref": "#/components/schemas/ItemType"
},
"parentOrder": {
"format": "int32",
"type": "integer"
},
"relationId": {
"format": "uuid",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"relationId",
"workspaceId",
"itemId",
"parentOrder",
"childOrder"
],
"title": "RelativeItemInfo",
"type": "object"
},
"ReorderFieldsRequest": {
"properties": {
"fieldIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"workspaceId",
"fieldIds"
],
"title": "ReorderFieldsRequest",
"type": "object"
},
"ResendUserInviteRequest": {
"properties": {
"email": {
"type": "string"
}
},
"required": [
"email"
],
"title": "ResendUserInviteRequest",
"type": "object"
},
"RichText": {
"examples": [
{
"blocks": [
{
"content": [
{
"content": "hello world",
"type": "text"
}
],
"type": "paragraph"
}
],
"richText": true
}
],
"properties": {
"blocks": {
"items": {
"$ref": "#/components/schemas/RichTextBlock"
},
"type": "array"
}
},
"required": [
"blocks"
],
"title": "RichText",
"type": "object"
},
"RichTextBlock": {
"discriminator": {
"mapping": {
"attachment": "#/components/schemas/RichTextBlockAttachment",
"blockquote": "#/components/schemas/RichTextBlockBlockquote",
"code": "#/components/schemas/RichTextBlockCode",
"custom": "#/components/schemas/RichTextBlockCustom",
"embed": "#/components/schemas/RichTextBlockEmbed",
"headline": "#/components/schemas/RichTextBlockHeadline",
"indentation": "#/components/schemas/RichTextBlockIndentation",
"list": "#/components/schemas/RichTextBlockList",
"panel": "#/components/schemas/RichTextBlockPanel",
"paragraph": "#/components/schemas/RichTextBlockParagraph"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/RichTextBlockAttachment"
},
{
"$ref": "#/components/schemas/RichTextBlockBlockquote"
},
{
"$ref": "#/components/schemas/RichTextBlockCode"
},
{
"$ref": "#/components/schemas/RichTextBlockCustom"
},
{
"$ref": "#/components/schemas/RichTextBlockEmbed"
},
{
"$ref": "#/components/schemas/RichTextBlockHeadline"
},
{
"$ref": "#/components/schemas/RichTextBlockIndentation"
},
{
"$ref": "#/components/schemas/RichTextBlockList"
},
{
"$ref": "#/components/schemas/RichTextBlockPanel"
},
{
"$ref": "#/components/schemas/RichTextBlockParagraph"
}
],
"title": "RichTextBlock"
},
"RichTextBlockAttachment": {
"properties": {
"attachmentId": {
"format": "uuid",
"type": "string"
},
"caption": {
"type": "string"
},
"contentType": {
"type": "string"
},
"meta": {
"type": "object"
},
"type": {
"const": "attachment",
"type": "string"
},
"width": {
"format": "int32",
"type": "integer"
}
},
"required": [
"attachmentId",
"contentType",
"type"
],
"title": "RichTextBlockAttachment",
"type": "object"
},
"RichTextBlockBlockquote": {
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/RichTextInline"
},
"type": "array"
},
"meta": {
"type": "object"
},
"type": {
"const": "blockquote",
"type": "string"
}
},
"required": [
"content",
"type"
],
"title": "RichTextBlockBlockquote",
"type": "object"
},
"RichTextBlockCode": {
"properties": {
"content": {
"type": "string"
},
"language": {
"type": "string"
},
"meta": {
"type": "object"
},
"type": {
"const": "code",
"type": "string"
}
},
"required": [
"content",
"type"
],
"title": "RichTextBlockCode",
"type": "object"
},
"RichTextBlockCustom": {
"properties": {
"id": {
"type": "string"
},
"meta": {
"type": "object"
},
"raw": {
"type": "string"
},
"type": {
"const": "custom",
"type": "string"
}
},
"required": [
"id",
"raw",
"type"
],
"title": "RichTextBlockCustom",
"type": "object"
},
"RichTextBlockEmbed": {
"properties": {
"caption": {
"type": "string"
},
"height": {
"format": "int32",
"type": "integer"
},
"meta": {
"type": "object"
},
"type": {
"const": "embed",
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"url",
"type"
],
"title": "RichTextBlockEmbed",
"type": "object"
},
"RichTextBlockHeadline": {
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/RichTextInline"
},
"type": "array"
},
"level": {
"format": "int32",
"type": "integer"
},
"meta": {
"type": "object"
},
"type": {
"const": "headline",
"type": "string"
}
},
"required": [
"level",
"content",
"type"
],
"title": "RichTextBlockHeadline",
"type": "object"
},
"RichTextBlockIndentation": {
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/RichTextBlock"
},
"type": "array"
},
"type": {
"const": "indentation",
"type": "string"
}
},
"required": [
"content",
"type"
],
"title": "RichTextBlockIndentation",
"type": "object"
},
"RichTextBlockList": {
"properties": {
"bulletListMarker": {
"type": "string"
},
"items": {
"items": {
"$ref": "#/components/schemas/RichTextListItem"
},
"type": "array"
},
"meta": {
"type": "object"
},
"ordered": {
"type": "boolean"
},
"orderedListDelimiter": {
"type": "string"
},
"orderedListStartsAt": {
"format": "int32",
"type": "integer"
},
"type": {
"const": "list",
"type": "string"
}
},
"required": [
"ordered",
"items",
"type"
],
"title": "RichTextBlockList",
"type": "object"
},
"RichTextBlockPanel": {
"properties": {
"colorHex": {
"type": "string"
},
"content": {
"items": {
"$ref": "#/components/schemas/RichTextBlock"
},
"type": "array"
},
"title": {
"type": "string"
},
"type": {
"const": "panel",
"type": "string"
}
},
"required": [
"content",
"type"
],
"title": "RichTextBlockPanel",
"type": "object"
},
"RichTextBlockParagraph": {
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/RichTextInline"
},
"type": "array"
},
"meta": {
"type": "object"
},
"type": {
"const": "paragraph",
"type": "string"
}
},
"required": [
"content",
"type"
],
"title": "RichTextBlockParagraph",
"type": "object"
},
"RichTextInline": {
"discriminator": {
"mapping": {
"bold": "#/components/schemas/RichTextInlineBold",
"code": "#/components/schemas/RichTextInlineCode",
"custom": "#/components/schemas/RichTextInlineCustom",
"groupMention": "#/components/schemas/RichTextInlineGroupMention",
"image": "#/components/schemas/RichTextInlineImage",
"italic": "#/components/schemas/RichTextInlineItalic",
"link": "#/components/schemas/RichTextInlineLink",
"mention": "#/components/schemas/RichTextInlineMention",
"strikeThrough": "#/components/schemas/RichTextInlineStrikeThrough",
"text": "#/components/schemas/RichTextInlineText",
"underline": "#/components/schemas/RichTextInlineUnderline"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/RichTextInlineBold"
},
{
"$ref": "#/components/schemas/RichTextInlineCode"
},
{
"$ref": "#/components/schemas/RichTextInlineCustom"
},
{
"$ref": "#/components/schemas/RichTextInlineGroupMention"
},
{
"$ref": "#/components/schemas/RichTextInlineImage"
},
{
"$ref": "#/components/schemas/RichTextInlineItalic"
},
{
"$ref": "#/components/schemas/RichTextInlineLink"
},
{
"$ref": "#/components/schemas/RichTextInlineMention"
},
{
"$ref": "#/components/schemas/RichTextInlineStrikeThrough"
},
{
"$ref": "#/components/schemas/RichTextInlineText"
},
{
"$ref": "#/components/schemas/RichTextInlineUnderline"
}
],
"title": "RichTextInline"
},
"RichTextInlineBold": {
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/RichTextInline"
},
"type": "array"
},
"type": {
"const": "bold",
"type": "string"
}
},
"required": [
"content",
"type"
],
"title": "RichTextInlineBold",
"type": "object"
},
"RichTextInlineCode": {
"properties": {
"content": {
"type": "string"
},
"meta": {
"type": "object"
},
"type": {
"const": "code",
"type": "string"
}
},
"required": [
"content",
"type"
],
"title": "RichTextInlineCode",
"type": "object"
},
"RichTextInlineCustom": {
"properties": {
"id": {
"type": "string"
},
"meta": {
"type": "object"
},
"raw": {
"type": "string"
},
"type": {
"const": "custom",
"type": "string"
}
},
"required": [
"id",
"raw",
"type"
],
"title": "RichTextInlineCustom",
"type": "object"
},
"RichTextInlineGroupMention": {
"properties": {
"meta": {
"type": "object"
},
"type": {
"const": "groupMention",
"type": "string"
},
"userGroupId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"userGroupId",
"type"
],
"title": "RichTextInlineGroupMention",
"type": "object"
},
"RichTextInlineImage": {
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/RichTextInline"
},
"type": "array"
},
"type": {
"const": "image",
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"content",
"url",
"type"
],
"title": "RichTextInlineImage",
"type": "object"
},
"RichTextInlineItalic": {
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/RichTextInline"
},
"type": "array"
},
"type": {
"const": "italic",
"type": "string"
}
},
"required": [
"content",
"type"
],
"title": "RichTextInlineItalic",
"type": "object"
},
"RichTextInlineLink": {
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/RichTextInline"
},
"type": "array"
},
"type": {
"const": "link",
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"content",
"url",
"type"
],
"title": "RichTextInlineLink",
"type": "object"
},
"RichTextInlineMention": {
"properties": {
"meta": {
"type": "object"
},
"type": {
"const": "mention",
"type": "string"
},
"userId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"userId",
"type"
],
"title": "RichTextInlineMention",
"type": "object"
},
"RichTextInlineStrikeThrough": {
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/RichTextInline"
},
"type": "array"
},
"type": {
"const": "strikeThrough",
"type": "string"
}
},
"required": [
"content",
"type"
],
"title": "RichTextInlineStrikeThrough",
"type": "object"
},
"RichTextInlineText": {
"properties": {
"content": {
"type": "string"
},
"meta": {
"type": "object"
},
"type": {
"const": "text",
"type": "string"
}
},
"required": [
"content",
"type"
],
"title": "RichTextInlineText",
"type": "object"
},
"RichTextInlineUnderline": {
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/RichTextInline"
},
"type": "array"
},
"type": {
"const": "underline",
"type": "string"
}
},
"required": [
"content",
"type"
],
"title": "RichTextInlineUnderline",
"type": "object"
},
"RichTextListItem": {
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/RichTextBlock"
},
"type": "array"
}
},
"required": [
"content"
],
"title": "RichTextListItem",
"type": "object"
},
"Role": {
"enum": [
"admin",
"contributor",
"editor"
],
"title": "Role",
"type": "string"
},
"SalesforceIntegrationSummary": {
"properties": {
"capabilities": {
"$ref": "#/components/schemas/IntegrationCapabilities"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"lastSyncAt": {
"format": "date-time",
"type": "string"
},
"lastSyncState": {
"$ref": "#/components/schemas/IntegrationSyncState"
},
"settings": {
"$ref": "#/components/schemas/SalesforceIntegrationTypeSettings"
},
"typeId": {
"const": "salesforce",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"createdAt",
"capabilities",
"enabled"
],
"title": "SalesforceIntegrationSummary",
"type": "object"
},
"SalesforceIntegrationTypeSettings": {
"properties": {
"autoSync": {
"type": "boolean"
},
"baseUrl": {
"type": "string"
},
"clientConnection": {
"$ref": "#/components/schemas/IntegrationClientConnectionSettings"
},
"importFrom": {
"format": "date",
"type": "string"
},
"mappings": {
"default": [],
"items": {
"$ref": "#/components/schemas/MappingSettingsIntegrationMappingSettings"
},
"type": "array"
},
"removeExtraneous": {
"type": "boolean"
},
"secrets": {
"$ref": "#/components/schemas/IntegrationSecrets"
},
"selectedSObject": {
"type": "string"
},
"soqlQuery": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"removeExtraneous",
"autoSync"
],
"title": "SalesforceIntegrationTypeSettings",
"type": "object"
},
"ScoringDirection": {
"enum": [
"higherIsBetter",
"lowerIsBetter"
],
"title": "ScoringDirection",
"type": "string"
},
"ScoringFormula": {
"discriminator": {
"mapping": {
"absolute": "#/components/schemas/ScoringFormulaAbsolute",
"addition": "#/components/schemas/ScoringFormulaAddition",
"constant": "#/components/schemas/ScoringFormulaConstant",
"criterionNormalizedNumericValue": "#/components/schemas/ScoringFormulaCriterionNormalizedNumericValue",
"criterionNumericValue": "#/components/schemas/ScoringFormulaCriterionNumericValue",
"division": "#/components/schemas/ScoringFormulaDivision",
"factorScore": "#/components/schemas/ScoringFormulaFactorScore",
"logarithm": "#/components/schemas/ScoringFormulaLogarithm",
"maximum": "#/components/schemas/ScoringFormulaMaximum",
"minimum": "#/components/schemas/ScoringFormulaMinimum",
"multiplication": "#/components/schemas/ScoringFormulaMultiplication",
"negative": "#/components/schemas/ScoringFormulaNegative",
"power": "#/components/schemas/ScoringFormulaPower",
"sqrt": "#/components/schemas/ScoringFormulaSquareRoot",
"subtraction": "#/components/schemas/ScoringFormulaSubtraction"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ScoringFormulaAbsolute"
},
{
"$ref": "#/components/schemas/ScoringFormulaAddition"
},
{
"$ref": "#/components/schemas/ScoringFormulaConstant"
},
{
"$ref": "#/components/schemas/ScoringFormulaCriterionNormalizedNumericValue"
},
{
"$ref": "#/components/schemas/ScoringFormulaCriterionNumericValue"
},
{
"$ref": "#/components/schemas/ScoringFormulaDivision"
},
{
"$ref": "#/components/schemas/ScoringFormulaFactorScore"
},
{
"$ref": "#/components/schemas/ScoringFormulaLogarithm"
},
{
"$ref": "#/components/schemas/ScoringFormulaMaximum"
},
{
"$ref": "#/components/schemas/ScoringFormulaMinimum"
},
{
"$ref": "#/components/schemas/ScoringFormulaMultiplication"
},
{
"$ref": "#/components/schemas/ScoringFormulaNegative"
},
{
"$ref": "#/components/schemas/ScoringFormulaPower"
},
{
"$ref": "#/components/schemas/ScoringFormulaSquareRoot"
},
{
"$ref": "#/components/schemas/ScoringFormulaSubtraction"
}
],
"title": "ScoringFormula"
},
"ScoringFormulaAbsolute": {
"properties": {
"innder": {
"$ref": "#/components/schemas/ScoringFormula"
},
"type": {
"const": "absolute",
"type": "string"
}
},
"required": [
"innder",
"type"
],
"title": "ScoringFormulaAbsolute",
"type": "object"
},
"ScoringFormulaAddition": {
"properties": {
"left": {
"$ref": "#/components/schemas/ScoringFormula"
},
"right": {
"$ref": "#/components/schemas/ScoringFormula"
},
"type": {
"const": "addition",
"type": "string"
}
},
"required": [
"left",
"right",
"type"
],
"title": "ScoringFormulaAddition",
"type": "object"
},
"ScoringFormulaConstant": {
"properties": {
"type": {
"const": "constant",
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"value",
"type"
],
"title": "ScoringFormulaConstant",
"type": "object"
},
"ScoringFormulaCriterionNormalizedNumericValue": {
"properties": {
"criterionId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "criterionNormalizedNumericValue",
"type": "string"
}
},
"required": [
"criterionId",
"type"
],
"title": "ScoringFormulaCriterionNormalizedNumericValue",
"type": "object"
},
"ScoringFormulaCriterionNumericValue": {
"properties": {
"criterionId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "criterionNumericValue",
"type": "string"
}
},
"required": [
"criterionId",
"type"
],
"title": "ScoringFormulaCriterionNumericValue",
"type": "object"
},
"ScoringFormulaDivision": {
"properties": {
"left": {
"$ref": "#/components/schemas/ScoringFormula"
},
"right": {
"$ref": "#/components/schemas/ScoringFormula"
},
"type": {
"const": "division",
"type": "string"
}
},
"required": [
"left",
"right",
"type"
],
"title": "ScoringFormulaDivision",
"type": "object"
},
"ScoringFormulaFactorScore": {
"properties": {
"factorId": {
"$ref": "#/components/schemas/FactorId"
},
"type": {
"const": "factorScore",
"type": "string"
}
},
"required": [
"factorId",
"type"
],
"title": "ScoringFormulaFactorScore",
"type": "object"
},
"ScoringFormulaLogarithm": {
"properties": {
"innder": {
"$ref": "#/components/schemas/ScoringFormula"
},
"type": {
"const": "logarithm",
"type": "string"
}
},
"required": [
"innder",
"type"
],
"title": "ScoringFormulaLogarithm",
"type": "object"
},
"ScoringFormulaMaximum": {
"properties": {
"arguments": {
"items": {
"$ref": "#/components/schemas/ScoringFormula"
},
"type": "array"
},
"type": {
"const": "maximum",
"type": "string"
}
},
"required": [
"arguments",
"type"
],
"title": "ScoringFormulaMaximum",
"type": "object"
},
"ScoringFormulaMinimum": {
"properties": {
"arguments": {
"items": {
"$ref": "#/components/schemas/ScoringFormula"
},
"type": "array"
},
"type": {
"const": "minimum",
"type": "string"
}
},
"required": [
"arguments",
"type"
],
"title": "ScoringFormulaMinimum",
"type": "object"
},
"ScoringFormulaMultiplication": {
"properties": {
"left": {
"$ref": "#/components/schemas/ScoringFormula"
},
"right": {
"$ref": "#/components/schemas/ScoringFormula"
},
"type": {
"const": "multiplication",
"type": "string"
}
},
"required": [
"left",
"right",
"type"
],
"title": "ScoringFormulaMultiplication",
"type": "object"
},
"ScoringFormulaNegative": {
"properties": {
"innder": {
"$ref": "#/components/schemas/ScoringFormula"
},
"type": {
"const": "negative",
"type": "string"
}
},
"required": [
"innder",
"type"
],
"title": "ScoringFormulaNegative",
"type": "object"
},
"ScoringFormulaPower": {
"properties": {
"left": {
"$ref": "#/components/schemas/ScoringFormula"
},
"right": {
"$ref": "#/components/schemas/ScoringFormula"
},
"type": {
"const": "power",
"type": "string"
}
},
"required": [
"left",
"right",
"type"
],
"title": "ScoringFormulaPower",
"type": "object"
},
"ScoringFormulaSquareRoot": {
"properties": {
"innder": {
"$ref": "#/components/schemas/ScoringFormula"
},
"type": {
"const": "sqrt",
"type": "string"
}
},
"required": [
"innder",
"type"
],
"title": "ScoringFormulaSquareRoot",
"type": "object"
},
"ScoringFormulaSubtraction": {
"properties": {
"left": {
"$ref": "#/components/schemas/ScoringFormula"
},
"right": {
"$ref": "#/components/schemas/ScoringFormula"
},
"type": {
"const": "subtraction",
"type": "string"
}
},
"required": [
"left",
"right",
"type"
],
"title": "ScoringFormulaSubtraction",
"type": "object"
},
"ScoringMode": {
"discriminator": {
"mapping": {
"customFormula": "#/components/schemas/ScoringModeCustomFormula",
"customWeighting": "#/components/schemas/ScoringModeCustomWeighting"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ScoringModeCustomFormula"
},
{
"$ref": "#/components/schemas/ScoringModeCustomWeighting"
}
],
"title": "ScoringMode"
},
"ScoringModeCustomFormula": {
"properties": {
"factorFormulas": {
"additionalProperties": {
"$ref": "#/components/schemas/ScoringFormula"
},
"type": "object"
},
"itemScoreFormula": {
"$ref": "#/components/schemas/ScoringFormula"
},
"type": {
"const": "customFormula",
"type": "string"
}
},
"required": [
"factorFormulas",
"itemScoreFormula",
"type"
],
"title": "ScoringModeCustomFormula",
"type": "object"
},
"ScoringModeCustomWeighting": {
"properties": {
"criterionWeights": {
"additionalProperties": {
"type": "number"
},
"type": "object"
},
"factorWeights": {
"additionalProperties": {
"type": "number"
},
"type": "object"
},
"type": {
"const": "customWeighting",
"type": "string"
}
},
"required": [
"factorWeights",
"criterionWeights",
"type"
],
"title": "ScoringModeCustomWeighting",
"type": "object"
},
"SearchPartialItemRequest": {
"properties": {
"properties": {
"items": {
"$ref": "#/components/schemas/RefItemExtendedProperty"
},
"type": "array",
"uniqueItems": true
},
"query": {
"$ref": "#/components/schemas/ItemSearchQuery",
"default": {
"archived": false,
"sort": {
"direction": "asc",
"type": "order"
}
}
}
},
"required": [
"properties"
],
"title": "SearchPartialItemRequest",
"type": "object"
},
"SelectField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/SelectFieldTypeSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "select",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "SelectField",
"type": "object"
},
"SelectFieldOptionColor": {
"enum": [
"blue",
"coco",
"daulphine",
"great",
"orange",
"pink",
"red",
"violet",
"yellow"
],
"title": "SelectFieldOptionColor",
"type": "string"
},
"SelectFieldTypeFilter": {
"discriminator": {
"mapping": {
"contain": "#/components/schemas/SelectFieldTypeFilterContain",
"containsAll": "#/components/schemas/SelectFieldTypeFilterContainsAll",
"containsAny": "#/components/schemas/SelectFieldTypeFilterContainsAny",
"defined": "#/components/schemas/SelectFieldTypeFilterDefined"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/SelectFieldTypeFilterContain"
},
{
"$ref": "#/components/schemas/SelectFieldTypeFilterContainsAll"
},
{
"$ref": "#/components/schemas/SelectFieldTypeFilterContainsAny"
},
{
"$ref": "#/components/schemas/SelectFieldTypeFilterDefined"
}
],
"title": "SelectFieldTypeFilter"
},
"SelectFieldTypeFilterContain": {
"properties": {
"id": {
"type": "string"
},
"type": {
"const": "contain",
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "SelectFieldTypeFilterContain",
"type": "object"
},
"SelectFieldTypeFilterContainsAll": {
"properties": {
"ids": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"type": {
"const": "containsAll",
"type": "string"
}
},
"required": [
"ids",
"type"
],
"title": "SelectFieldTypeFilterContainsAll",
"type": "object"
},
"SelectFieldTypeFilterContainsAny": {
"properties": {
"ids": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"type": {
"const": "containsAny",
"type": "string"
}
},
"required": [
"ids",
"type"
],
"title": "SelectFieldTypeFilterContainsAny",
"type": "object"
},
"SelectFieldTypeFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "SelectFieldTypeFilterDefined",
"type": "object"
},
"SelectFieldTypeOption": {
"properties": {
"autofillPrompt": {
"type": "string"
},
"color": {
"$ref": "#/components/schemas/SelectFieldOptionColor"
},
"default": {
"type": "boolean"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"numericValue": {
"type": "number"
}
},
"required": [
"id",
"name",
"description",
"default"
],
"title": "SelectFieldTypeOption",
"type": "object"
},
"SelectFieldTypeSettings": {
"properties": {
"aiSettings": {
"$ref": "#/components/schemas/AiFieldSettings"
},
"multi": {
"type": "boolean"
},
"options": {
"items": {
"$ref": "#/components/schemas/SelectFieldTypeOption"
},
"type": "array"
}
},
"required": [
"options",
"multi"
],
"title": "SelectFieldTypeSettings",
"type": "object"
},
"SelectFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/SelectFieldTypeSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "select",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "SelectFieldWithFieldEmbed",
"type": "object"
},
"SetClientSettingsRequest": {
"properties": {
"path": {
"type": "string"
},
"value": {}
},
"required": [
"value"
],
"title": "SetClientSettingsRequest",
"type": "object"
},
"SetWorkspaceStatusPresetRequest": {
"properties": {
"replacements": {
"additionalProperties": {
"format": "uuid",
"type": "string"
},
"description": "A map of status replacements, where key is an OLD status-id and value is a NEW status-id. Replacements must be specified for each status being removed when switching presets. This mapping will be used to migrate all items in the workspace to new statuses before deleting the old ones.",
"type": "object"
},
"statusPresetId": {
"description": "Status preset ID to assign to this workspace. Set to null to unassign the current preset.",
"format": "uuid",
"type": "string"
}
},
"required": [
"replacements"
],
"title": "SetWorkspaceStatusPresetRequest",
"type": "object"
},
"SetWorkspaceStatusesRequest": {
"properties": {
"replacements": {
"additionalProperties": {
"format": "uuid",
"type": "string"
},
"description": "A map of status replacements, where key is and OLD status-id and value is a NEW status-id. Replacements must be specified for each status being deleted from the workspace.This mapping will be used to migrate all items in the workspace to new statuses before deleting the old ones.",
"type": "object"
},
"statuses": {
"description": "Statuses to be set for the specified workspace. New statuses will be added to database, missing statuses will be removed from database.",
"items": {
"$ref": "#/components/schemas/Status"
},
"type": "array"
}
},
"required": [
"statuses",
"replacements"
],
"title": "SetWorkspaceStatusesRequest",
"type": "object"
},
"ShortcutIntegrationTypeSettings": {
"properties": {
"apiKey": {
"type": "string"
},
"autoSync": {
"type": "boolean"
},
"mappings": {
"default": [],
"items": {
"$ref": "#/components/schemas/MappingSettingsIntegrationMappingSettings"
},
"type": "array"
},
"removeExtraneous": {
"type": "boolean"
},
"selectLabels": {
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"selectProjects": {
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"selectWorkflow": {
"format": "int64",
"type": "integer"
},
"title": {
"type": "string"
}
},
"required": [
"autoSync"
],
"title": "ShortcutIntegrationTypeSettings",
"type": "object"
},
"Status": {
"examples": [
{
"category": "active",
"color": "blue",
"default": true,
"id": "7e5a6ca1-93e2-3b2b-8c07-c911b370ff40",
"name": "In Progress",
"order": 1,
"presetId": "aabe8348-a1b8-371c-be47-4c43039dcc6e",
"workspaceId": "668953d2-25f2-34fd-bd72-1e8cf024a277"
}
],
"properties": {
"category": {
"$ref": "#/components/schemas/StatusCategory"
},
"color": {
"$ref": "#/components/schemas/StatusColor"
},
"default": {
"description": "Whether this status should be applied by default to newly created items. There can be only one default status in each workspace.",
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"description": "Name of this status in UI.",
"type": "string"
},
"order": {
"description": "Order of this status comparing to other statuses in the same workspace.",
"format": "int32",
"type": "integer"
},
"presetId": {
"description": "Id of the status preset it is part of. Empty if this status is custom for a workspace.",
"format": "uuid",
"type": "string"
},
"workspaceId": {
"description": "The workspace this status belongs to. Empty for preset statuses, which are shared across workspaces",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"category",
"name",
"default",
"order"
],
"title": "Status",
"type": "object"
},
"StatusCategory": {
"description": "Status category adds some additional meaning to each status:\n- 'draft': only semantic meaning\n- 'active': only semantic meaning\n- 'closed': items with a status in this category will be considered as completed, which contributes to progress calculation (e.g. \"1/3 items completed\").",
"enum": [
"active",
"closed",
"draft"
],
"title": "StatusCategory",
"type": "string"
},
"StatusColor": {
"description": "Color of a status-chip in UI.",
"enum": [
"blue",
"coco",
"daulphine",
"great",
"orange",
"pink",
"red",
"violet",
"yellow"
],
"title": "StatusColor",
"type": "string"
},
"StatusPreset": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"description": "Name of this status preset.",
"type": "string"
},
"teamId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"teamId",
"name"
],
"title": "StatusPreset",
"type": "object"
},
"StatusPresetBulkAction": {
"discriminator": {
"mapping": {
"create": "#/components/schemas/StatusPresetBulkCreate",
"delete": "#/components/schemas/StatusPresetBulkDelete",
"patch": "#/components/schemas/StatusPresetBulkPatch",
"update": "#/components/schemas/StatusPresetBulkUpdate"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/StatusPresetBulkCreate"
},
{
"$ref": "#/components/schemas/StatusPresetBulkDelete"
},
{
"$ref": "#/components/schemas/StatusPresetBulkPatch"
},
{
"$ref": "#/components/schemas/StatusPresetBulkUpdate"
}
],
"title": "StatusPresetBulkAction"
},
"StatusPresetBulkCreate": {
"properties": {
"resource": {
"$ref": "#/components/schemas/CreateStatusPresetRequest"
},
"type": {
"enum": [
"create"
],
"type": "string"
}
},
"required": [
"resource",
"type"
],
"title": "StatusPresetBulkCreate",
"type": "object"
},
"StatusPresetBulkDelete": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"type": {
"enum": [
"delete"
],
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "StatusPresetBulkDelete",
"type": "object"
},
"StatusPresetBulkPatch": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"transform": {
"$ref": "#/components/schemas/JsonPatch"
},
"type": {
"enum": [
"patch"
],
"type": "string"
}
},
"required": [
"id",
"transform",
"type"
],
"title": "StatusPresetBulkPatch",
"type": "object"
},
"StatusPresetBulkUpdate": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/UpdateStatusPresetRequest"
},
"type": {
"enum": [
"update"
],
"type": "string"
}
},
"required": [
"id",
"resource",
"type"
],
"title": "StatusPresetBulkUpdate",
"type": "object"
},
"StatusPresetEmbed": {
"properties": {
"itemStatusCount": {
"additionalProperties": {
"format": "int32",
"type": "integer"
},
"type": "object"
},
"itemStatusCountArchived": {
"additionalProperties": {
"format": "int32",
"type": "integer"
},
"type": "object"
},
"statuses": {
"items": {
"$ref": "#/components/schemas/Status"
},
"type": "array"
},
"workspaceIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"statuses",
"workspaceIds",
"itemStatusCount",
"itemStatusCountArchived"
],
"title": "StatusPresetEmbed",
"type": "object"
},
"StatusPresetSearchQuery": {
"title": "StatusPresetSearchQuery",
"type": "object"
},
"StatusPresetWithStatusPresetEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/StatusPresetEmbed"
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"description": "Name of this status preset.",
"type": "string"
},
"teamId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"teamId",
"name",
"_embedded"
],
"title": "StatusPresetWithStatusPresetEmbed",
"type": "object"
},
"StatusPresetWithStatusPresetEmbedOrNullList": {
"items": {
"$ref": "#/components/schemas/StatusPresetWithStatusPresetEmbed"
},
"title": "StatusPresetWithStatusPresetEmbedOrNullList",
"type": "array"
},
"StatusPresetWithStatusPresetEmbedPage": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/StatusPresetWithStatusPresetEmbed"
},
"type": "array"
},
"totalItems": {
"format": "int32",
"type": "integer"
}
},
"required": [
"items",
"totalItems"
],
"title": "StatusPresetWithStatusPresetEmbedPage",
"type": "object"
},
"StoreAcceptedTosRequest": {
"properties": {
"text": {
"type": "string"
}
},
"required": [
"text"
],
"title": "StoreAcceptedTosRequest",
"type": "object"
},
"SwimlaneMode": {
"discriminator": {
"mapping": {
"app": "#/components/schemas/SwimlaneModeApp",
"assignees": "#/components/schemas/SwimlaneModeAssignees",
"field": "#/components/schemas/SwimlaneModeField",
"parent": "#/components/schemas/SwimlaneModeParent",
"status": "#/components/schemas/SwimlaneModeStatus",
"statusCategory": "#/components/schemas/SwimlaneModeStatusCategory"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/SwimlaneModeApp"
},
{
"$ref": "#/components/schemas/SwimlaneModeAssignees"
},
{
"$ref": "#/components/schemas/SwimlaneModeField"
},
{
"$ref": "#/components/schemas/SwimlaneModeParent"
},
{
"$ref": "#/components/schemas/SwimlaneModeStatus"
},
{
"$ref": "#/components/schemas/SwimlaneModeStatusCategory"
}
],
"title": "SwimlaneMode"
},
"SwimlaneModeApp": {
"properties": {
"appId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "app",
"type": "string"
}
},
"required": [
"appId",
"type"
],
"title": "SwimlaneModeApp",
"type": "object"
},
"SwimlaneModeAssignees": {
"properties": {
"type": {
"const": "assignees",
"type": "string"
}
},
"required": [
"type"
],
"title": "SwimlaneModeAssignees",
"type": "object"
},
"SwimlaneModeField": {
"properties": {
"fieldId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "field",
"type": "string"
}
},
"required": [
"fieldId",
"type"
],
"title": "SwimlaneModeField",
"type": "object"
},
"SwimlaneModeParent": {
"properties": {
"type": {
"const": "parent",
"type": "string"
}
},
"required": [
"type"
],
"title": "SwimlaneModeParent",
"type": "object"
},
"SwimlaneModeStatus": {
"properties": {
"type": {
"const": "status",
"type": "string"
}
},
"required": [
"type"
],
"title": "SwimlaneModeStatus",
"type": "object"
},
"SwimlaneModeStatusCategory": {
"properties": {
"type": {
"const": "statusCategory",
"type": "string"
}
},
"required": [
"type"
],
"title": "SwimlaneModeStatusCategory",
"type": "object"
},
"TableViewTypeSettings": {
"properties": {
"groupBy": {
"default": [],
"items": {
"$ref": "#/components/schemas/GroupBy"
},
"type": "array"
},
"showAlias": {
"default": false,
"type": "boolean"
},
"showAssignees": {
"default": false,
"type": "boolean"
},
"showCreatedAt": {
"default": false,
"type": "boolean"
},
"showFieldIds": {
"default": [],
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"showFieldTypes": {
"default": [],
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"showIntegrations": {
"default": false,
"type": "boolean"
},
"showLastUpdatedAt": {
"default": false,
"type": "boolean"
},
"showParentItems": {
"default": false,
"type": "boolean"
},
"showProgress": {
"default": true,
"type": "boolean"
},
"showStatus": {
"default": true,
"type": "boolean"
},
"viewMode": {
"$ref": "#/components/schemas/ViewMode"
}
},
"title": "TableViewTypeSettings",
"type": "object"
},
"TableViewWithViewEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/ViewEmbed"
},
"description": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isPrivate": {
"type": "boolean"
},
"itemFilter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"itemScopeLimit": {
"$ref": "#/components/schemas/ItemScopeLimit"
},
"itemSort": {
"items": {
"$ref": "#/components/schemas/ItemSearchQuerySort"
},
"type": "array"
},
"name": {
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"pinnedToPosition": {
"format": "int32",
"type": "integer"
},
"settings": {
"$ref": "#/components/schemas/TableViewTypeSettings"
},
"typeId": {
"const": "table",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"typeId",
"settings",
"name",
"description",
"itemSort",
"order",
"isPrivate",
"_embedded"
],
"title": "TableViewWithViewEmbed",
"type": "object"
},
"Team": {
"properties": {
"companyInfo": {
"$ref": "#/components/schemas/TeamCompanyInfo"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"flags": {
"$ref": "#/components/schemas/TeamFlags"
},
"name": {
"description": "Display name for the team.",
"type": "string"
},
"slug": {
"description": "Identifier that is unique for each team. The slug is used as the subdomain prefix (e.g., 'myteam' in myteam.airfocus.com).",
"type": "string"
},
"state": {
"$ref": "#/components/schemas/TeamState"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"type": "string"
}
},
"required": [
"teamId",
"slug",
"name",
"state",
"flags",
"createdAt",
"updatedAt"
],
"title": "Team",
"type": "object"
},
"TeamCompanyInfo": {
"properties": {
"role": {
"$ref": "#/components/schemas/TeamCompanyInfoRole"
},
"size": {
"$ref": "#/components/schemas/TeamCompanyInfoSize"
},
"telephone": {
"type": "string"
}
},
"required": [
"size",
"role"
],
"title": "TeamCompanyInfo",
"type": "object"
},
"TeamCompanyInfoRole": {
"enum": [
"customerSuccess",
"design",
"engineering",
"marketing",
"notListed",
"productManagement",
"projectManagement",
"sales",
"unknown"
],
"title": "TeamCompanyInfoRole",
"type": "string"
},
"TeamCompanyInfoSize": {
"enum": [
"range1000plus",
"range11to50",
"range1to10",
"range201to1000",
"range51to200",
"unknown"
],
"title": "TeamCompanyInfoSize",
"type": "string"
},
"TeamFlag": {
"properties": {
"enforced": {
"type": "boolean"
},
"explicit": {
"type": "boolean"
},
"value": {
"type": "boolean"
}
},
"required": [
"value",
"enforced",
"explicit"
],
"title": "TeamFlag",
"type": "object"
},
"TeamFlags": {
"properties": {
"enableAi": {
"$ref": "#/components/schemas/TeamFlag"
},
"enableMcpServer": {
"$ref": "#/components/schemas/TeamFlag"
},
"enableOkrApp": {
"$ref": "#/components/schemas/TeamFlag"
},
"forbidShareLinkCreation": {
"$ref": "#/components/schemas/TeamFlag"
},
"removeBranding": {
"$ref": "#/components/schemas/TeamFlag"
},
"requirePortalLogin": {
"$ref": "#/components/schemas/TeamFlag"
},
"requirePortalPassword": {
"$ref": "#/components/schemas/TeamFlag"
},
"requireShareLinkPassword": {
"$ref": "#/components/schemas/TeamFlag"
},
"restrictIntegrationManagement": {
"$ref": "#/components/schemas/TeamFlag"
},
"restrictShareLinkCreation": {
"$ref": "#/components/schemas/TeamFlag"
}
},
"required": [
"enableAi",
"enableOkrApp",
"removeBranding",
"forbidShareLinkCreation",
"restrictIntegrationManagement",
"restrictShareLinkCreation",
"requireShareLinkPassword",
"requirePortalLogin",
"requirePortalPassword",
"enableMcpServer"
],
"title": "TeamFlags",
"type": "object"
},
"TeamMaintenanceWindow": {
"properties": {
"linkLabel": {
"type": "string"
},
"linkUrl": {
"type": "string"
},
"message": {
"type": "string"
},
"scheduledEnd": {
"format": "date-time",
"type": "string"
},
"scheduledStart": {
"format": "date-time",
"type": "string"
}
},
"required": [
"scheduledStart",
"scheduledEnd",
"message"
],
"title": "TeamMaintenanceWindow",
"type": "object"
},
"TeamState": {
"properties": {
"features": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"seats": {
"$ref": "#/components/schemas/TeamStateAllTeamStateSeats"
},
"subscription": {
"$ref": "#/components/schemas/TeamStateSubscription"
},
"trialUntil": {
"deprecated": true,
"format": "date-time",
"type": "string"
},
"workspaces": {
"$ref": "#/components/schemas/TeamStateWorkspaces"
}
},
"required": [
"features",
"seats",
"workspaces",
"subscription"
],
"title": "TeamState",
"type": "object"
},
"TeamStateAllTeamStateSeats": {
"properties": {
"admin": {
"$ref": "#/components/schemas/TeamStateSeats"
},
"any": {
"$ref": "#/components/schemas/TeamStateSeats"
},
"contributor": {
"$ref": "#/components/schemas/TeamStateSeats"
},
"editor": {
"$ref": "#/components/schemas/TeamStateSeats"
}
},
"title": "TeamStateAllTeamStateSeats",
"type": "object"
},
"TeamStateSeats": {
"properties": {
"free": {
"format": "int32",
"type": "integer"
},
"total": {
"type": "integer"
},
"used": {
"format": "int32",
"type": "integer"
}
},
"required": [
"total",
"used",
"free"
],
"title": "TeamStateSeats",
"type": "object"
},
"TeamStateSubscription": {
"discriminator": {
"mapping": {
"expired": "#/components/schemas/TeamStateSubscriptionExpired",
"subscribed": "#/components/schemas/TeamStateSubscriptionSubscribed",
"trial": "#/components/schemas/TeamStateSubscriptionTrial"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/TeamStateSubscriptionExpired"
},
{
"$ref": "#/components/schemas/TeamStateSubscriptionSubscribed"
},
{
"$ref": "#/components/schemas/TeamStateSubscriptionTrial"
}
],
"title": "TeamStateSubscription"
},
"TeamStateSubscriptionExpired": {
"properties": {
"trialUntil": {
"format": "date-time",
"type": "string"
},
"type": {
"const": "expired",
"type": "string"
}
},
"required": [
"trialUntil",
"type"
],
"title": "TeamStateSubscriptionExpired",
"type": "object"
},
"TeamStateSubscriptionSubscribed": {
"properties": {
"type": {
"const": "subscribed",
"type": "string"
}
},
"required": [
"type"
],
"title": "TeamStateSubscriptionSubscribed",
"type": "object"
},
"TeamStateSubscriptionTrial": {
"properties": {
"trialUntil": {
"format": "date-time",
"type": "string"
},
"type": {
"const": "trial",
"type": "string"
}
},
"required": [
"trialUntil",
"type"
],
"title": "TeamStateSubscriptionTrial",
"type": "object"
},
"TeamStateWorkspaces": {
"properties": {
"total": {
"type": "integer"
}
},
"required": [
"total"
],
"title": "TeamStateWorkspaces",
"type": "object"
},
"Template": {
"properties": {
"abstract": {
"type": "string"
},
"apps": {
"items": {
"$ref": "#/components/schemas/TemplateApp"
},
"type": "array"
},
"description": {
"type": "string"
},
"featured": {
"type": "boolean"
},
"id": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"name": {
"type": "string"
},
"views": {
"items": {
"$ref": "#/components/schemas/TemplateView"
},
"type": "array"
},
"viewsSectionTitle": {
"type": "string"
},
"workspacesCount": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"name",
"featured",
"abstract",
"description",
"viewsSectionTitle",
"workspacesCount",
"apps",
"views"
],
"title": "Template",
"type": "object"
},
"TemplateApp": {
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"typeId": {
"type": "string"
}
},
"required": [
"typeId",
"name"
],
"title": "TemplateApp",
"type": "object"
},
"TemplateCategory": {
"properties": {
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"templateIds": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"slug",
"name",
"templateIds"
],
"title": "TemplateCategory",
"type": "object"
},
"TemplateInstructions": {
"properties": {
"apps": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsInstallApp"
},
"type": "array"
},
"fields": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsInstallField"
},
"type": "array"
},
"itemRelations": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsCreateItemRelation"
},
"type": "array"
},
"items": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsCreateItem"
},
"type": "array"
},
"links": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsCreateLink"
},
"type": "array"
},
"statuses": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsCreateStatus"
},
"type": "array"
},
"views": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsInstallView"
},
"type": "array"
},
"workspaceGroups": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsCreateWorkspaceGroup"
},
"type": "array"
},
"workspaceRelations": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsCreateWorkspaceRelation"
},
"type": "array"
},
"workspaces": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsCreateWorkspace"
},
"type": "array"
}
},
"title": "TemplateInstructions",
"type": "object"
},
"TemplateInstructionsCreateItem": {
"properties": {
"assigneeUserIds": {
"default": [],
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"color": {
"$ref": "#/components/schemas/ItemColor"
},
"conditions": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsInstructionCondition"
},
"type": "array"
},
"description": {
"$ref": "#/components/schemas/RichText",
"description": "Rich text content as structured blocks. Different media types provide markdown support:\n• application/json - Default blocks format\n• application/vnd.airfocus.markdown+json - All RichText fields become markdown strings (recommended)\n• application/json+markdown - Legacy format, only top-level fields converted to markdown"
},
"fields": {
"additionalProperties": {},
"type": "object"
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"statusId": {
"format": "uuid",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"statusId",
"name",
"description",
"color",
"fields",
"order"
],
"title": "TemplateInstructionsCreateItem",
"type": "object"
},
"TemplateInstructionsCreateItemRelation": {
"properties": {
"childId": {
"format": "uuid",
"type": "string"
},
"childOrder": {
"format": "int32",
"type": "integer"
},
"conditions": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsInstructionCondition"
},
"type": "array"
},
"id": {
"format": "uuid",
"type": "string"
},
"parentId": {
"format": "uuid",
"type": "string"
},
"parentOrder": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"parentId",
"childId",
"parentOrder",
"childOrder"
],
"title": "TemplateInstructionsCreateItemRelation",
"type": "object"
},
"TemplateInstructionsCreateLink": {
"properties": {
"conditions": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsInstructionCondition"
},
"type": "array"
},
"fromItemId": {
"format": "uuid",
"type": "string"
},
"fromOrder": {
"format": "int32",
"type": "integer"
},
"id": {
"format": "uuid",
"type": "string"
},
"linkTypeId": {
"format": "uuid",
"type": "string"
},
"toItemId": {
"format": "uuid",
"type": "string"
},
"toOrder": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"fromItemId",
"toItemId",
"linkTypeId",
"fromOrder",
"toOrder"
],
"title": "TemplateInstructionsCreateLink",
"type": "object"
},
"TemplateInstructionsCreateStatus": {
"properties": {
"category": {
"$ref": "#/components/schemas/StatusCategory"
},
"color": {
"$ref": "#/components/schemas/StatusColor"
},
"conditions": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsInstructionCondition"
},
"type": "array"
},
"default": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"value": {
"type": "number"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"category",
"name",
"default",
"value",
"order"
],
"title": "TemplateInstructionsCreateStatus",
"type": "object"
},
"TemplateInstructionsCreateWorkspace": {
"properties": {
"archived": {
"type": "boolean"
},
"conditions": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsInstructionCondition"
},
"type": "array"
},
"id": {
"format": "uuid",
"type": "string"
},
"itemColor": {
"$ref": "#/components/schemas/ItemColor"
},
"itemType": {
"$ref": "#/components/schemas/ItemType"
},
"metadata": {
"$ref": "#/components/schemas/WorkspaceWorkspaceMetadata"
},
"name": {
"type": "string"
},
"namespace": {
"$ref": "#/components/schemas/WorkspaceNamespace"
},
"orderedFieldIds": {
"default": [],
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"parentGroupId": {
"format": "uuid",
"type": "string"
},
"progressMode": {
"$ref": "#/components/schemas/WorkspaceProgressMode"
},
"statusPresetId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"name",
"progressMode",
"namespace",
"archived"
],
"title": "TemplateInstructionsCreateWorkspace",
"type": "object"
},
"TemplateInstructionsCreateWorkspaceGroup": {
"properties": {
"conditions": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsInstructionCondition"
},
"type": "array"
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"parentId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "TemplateInstructionsCreateWorkspaceGroup",
"type": "object"
},
"TemplateInstructionsCreateWorkspaceRelation": {
"properties": {
"childId": {
"format": "uuid",
"type": "string"
},
"conditions": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsInstructionCondition"
},
"type": "array"
},
"id": {
"format": "uuid",
"type": "string"
},
"parentId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"parentId",
"childId"
],
"title": "TemplateInstructionsCreateWorkspaceRelation",
"type": "object"
},
"TemplateInstructionsInstallApp": {
"properties": {
"conditions": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsInstructionCondition"
},
"type": "array"
},
"fields": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsInstallField"
},
"type": "array"
},
"id": {
"format": "uuid",
"type": "string"
},
"settings": {},
"typeId": {
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings"
],
"title": "TemplateInstructionsInstallApp",
"type": "object"
},
"TemplateInstructionsInstallField": {
"properties": {
"conditions": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsInstructionCondition"
},
"type": "array"
},
"description": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"settings": {},
"typeId": {
"type": "string"
},
"workspaceIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"id",
"workspaceIds",
"name",
"description",
"typeId",
"settings",
"isTeamField"
],
"title": "TemplateInstructionsInstallField",
"type": "object"
},
"TemplateInstructionsInstallView": {
"properties": {
"conditions": {
"default": [],
"items": {
"$ref": "#/components/schemas/TemplateInstructionsInstructionCondition"
},
"type": "array"
},
"description": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"itemFilter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"itemScopeLimit": {
"$ref": "#/components/schemas/ItemScopeLimit"
},
"itemSort": {
"default": [],
"items": {
"$ref": "#/components/schemas/ItemSearchQuerySort"
},
"type": "array"
},
"name": {
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"pinnedToPosition": {
"format": "int32",
"type": "integer"
},
"settings": {},
"typeId": {
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"name",
"description",
"typeId",
"settings",
"order"
],
"title": "TemplateInstructionsInstallView",
"type": "object"
},
"TemplateInstructionsInstructionCondition": {
"discriminator": {
"mapping": {
"mustHaveFeature": "#/components/schemas/TemplateInstructionsInstructionConditionMustHaveFeature",
"mustNotHaveFeature": "#/components/schemas/TemplateInstructionsInstructionConditionMustNotHaveFeature"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/TemplateInstructionsInstructionConditionMustHaveFeature"
},
{
"$ref": "#/components/schemas/TemplateInstructionsInstructionConditionMustNotHaveFeature"
}
],
"title": "TemplateInstructionsInstructionCondition"
},
"TemplateInstructionsInstructionConditionMustHaveFeature": {
"properties": {
"feature": {
"type": "string"
},
"type": {
"const": "mustHaveFeature",
"type": "string"
}
},
"required": [
"feature",
"type"
],
"title": "TemplateInstructionsInstructionConditionMustHaveFeature",
"type": "object"
},
"TemplateInstructionsInstructionConditionMustNotHaveFeature": {
"properties": {
"feature": {
"type": "string"
},
"type": {
"const": "mustNotHaveFeature",
"type": "string"
}
},
"required": [
"feature",
"type"
],
"title": "TemplateInstructionsInstructionConditionMustNotHaveFeature",
"type": "object"
},
"TemplatePageWithEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/TemplateSearchEmbed"
},
"items": {
"items": {
"$ref": "#/components/schemas/Template"
},
"type": "array"
},
"totalItems": {
"format": "int32",
"type": "integer"
}
},
"required": [
"items",
"_embedded",
"totalItems"
],
"title": "TemplatePageWithEmbed",
"type": "object"
},
"TemplateParameters": {
"properties": {
"insightsTargetWorkspaceId": {
"format": "uuid",
"type": "string"
}
},
"title": "TemplateParameters",
"type": "object"
},
"TemplateSearchEmbed": {
"properties": {
"categories": {
"items": {
"$ref": "#/components/schemas/TemplateCategory"
},
"type": "array"
}
},
"required": [
"categories"
],
"title": "TemplateSearchEmbed",
"type": "object"
},
"TemplateView": {
"properties": {
"description": {
"type": "string"
},
"iconName": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"imageUrl"
],
"title": "TemplateView",
"type": "object"
},
"TextField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "text",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "TextField",
"type": "object"
},
"TextFieldTypeFilter": {
"discriminator": {
"mapping": {
"contain": "#/components/schemas/TextFieldTypeFilterContain",
"defined": "#/components/schemas/TextFieldTypeFilterDefined",
"equal": "#/components/schemas/TextFieldTypeFilterEqual"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/TextFieldTypeFilterContain"
},
{
"$ref": "#/components/schemas/TextFieldTypeFilterDefined"
},
{
"$ref": "#/components/schemas/TextFieldTypeFilterEqual"
}
],
"title": "TextFieldTypeFilter"
},
"TextFieldTypeFilterContain": {
"properties": {
"caseSensitive": {
"default": false,
"type": "boolean"
},
"text": {
"type": "string"
},
"type": {
"const": "contain",
"type": "string"
}
},
"required": [
"text",
"type"
],
"title": "TextFieldTypeFilterContain",
"type": "object"
},
"TextFieldTypeFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "TextFieldTypeFilterDefined",
"type": "object"
},
"TextFieldTypeFilterEqual": {
"properties": {
"caseSensitive": {
"default": false,
"type": "boolean"
},
"text": {
"type": "string"
},
"type": {
"const": "equal",
"type": "string"
}
},
"required": [
"text",
"type"
],
"title": "TextFieldTypeFilterEqual",
"type": "object"
},
"TextFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "text",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "TextFieldWithFieldEmbed",
"type": "object"
},
"TimePeriod": {
"properties": {
"endDate": {
"format": "date",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"label": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
}
},
"required": [
"id",
"label",
"startDate",
"endDate"
],
"title": "TimePeriod",
"type": "object"
},
"TimePeriodField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/TimePeriodFieldSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "time-period",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "TimePeriodField",
"type": "object"
},
"TimePeriodFieldFilter": {
"discriminator": {
"mapping": {
"containsAll": "#/components/schemas/TimePeriodFieldFilterContainsAll",
"containsAny": "#/components/schemas/TimePeriodFieldFilterContainsAny",
"defined": "#/components/schemas/TimePeriodFieldFilterDefined",
"endBefore": "#/components/schemas/TimePeriodFieldFilterEndBefore",
"endBeforeOrOn": "#/components/schemas/TimePeriodFieldFilterEndBeforeOrOn",
"endsBeforeEndOf": "#/components/schemas/TimePeriodFieldFilterEndsBeforeEndOf",
"endsBeforeStartOf": "#/components/schemas/TimePeriodFieldFilterEndsBeforeStartOf",
"startAfter": "#/components/schemas/TimePeriodFieldFilterStartAfter",
"startAfterOrOn": "#/components/schemas/TimePeriodFieldFilterStartAfterOrOn",
"startsAfterEndOf": "#/components/schemas/TimePeriodFieldFilterStartsAfterEndOf",
"startsFromStartOf": "#/components/schemas/TimePeriodFieldFilterStartsFromStartOf"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/TimePeriodFieldFilterContainsAll"
},
{
"$ref": "#/components/schemas/TimePeriodFieldFilterContainsAny"
},
{
"$ref": "#/components/schemas/TimePeriodFieldFilterDefined"
},
{
"$ref": "#/components/schemas/TimePeriodFieldFilterEndBefore"
},
{
"$ref": "#/components/schemas/TimePeriodFieldFilterEndBeforeOrOn"
},
{
"$ref": "#/components/schemas/TimePeriodFieldFilterEndsBeforeEndOf"
},
{
"$ref": "#/components/schemas/TimePeriodFieldFilterEndsBeforeStartOf"
},
{
"$ref": "#/components/schemas/TimePeriodFieldFilterStartAfter"
},
{
"$ref": "#/components/schemas/TimePeriodFieldFilterStartAfterOrOn"
},
{
"$ref": "#/components/schemas/TimePeriodFieldFilterStartsAfterEndOf"
},
{
"$ref": "#/components/schemas/TimePeriodFieldFilterStartsFromStartOf"
}
],
"title": "TimePeriodFieldFilter"
},
"TimePeriodFieldFilterContainsAll": {
"properties": {
"timePeriods": {
"items": {
"$ref": "#/components/schemas/TimePeriodRef"
},
"type": "array",
"uniqueItems": true
},
"type": {
"const": "containsAll",
"type": "string"
}
},
"required": [
"timePeriods",
"type"
],
"title": "TimePeriodFieldFilterContainsAll",
"type": "object"
},
"TimePeriodFieldFilterContainsAny": {
"properties": {
"timePeriods": {
"items": {
"$ref": "#/components/schemas/TimePeriodRef"
},
"type": "array",
"uniqueItems": true
},
"type": {
"const": "containsAny",
"type": "string"
}
},
"required": [
"timePeriods",
"type"
],
"title": "TimePeriodFieldFilterContainsAny",
"type": "object"
},
"TimePeriodFieldFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "TimePeriodFieldFilterDefined",
"type": "object"
},
"TimePeriodFieldFilterEndBefore": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"type": {
"const": "endBefore",
"type": "string"
}
},
"required": [
"date",
"type"
],
"title": "TimePeriodFieldFilterEndBefore",
"type": "object"
},
"TimePeriodFieldFilterEndBeforeOrOn": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"type": {
"const": "endBeforeOrOn",
"type": "string"
}
},
"required": [
"date",
"type"
],
"title": "TimePeriodFieldFilterEndBeforeOrOn",
"type": "object"
},
"TimePeriodFieldFilterEndsBeforeEndOf": {
"properties": {
"timePeriod": {
"$ref": "#/components/schemas/TimePeriodRef"
},
"type": {
"const": "endsBeforeEndOf",
"type": "string"
}
},
"required": [
"timePeriod",
"type"
],
"title": "TimePeriodFieldFilterEndsBeforeEndOf",
"type": "object"
},
"TimePeriodFieldFilterEndsBeforeStartOf": {
"properties": {
"timePeriod": {
"$ref": "#/components/schemas/TimePeriodRef"
},
"type": {
"const": "endsBeforeStartOf",
"type": "string"
}
},
"required": [
"timePeriod",
"type"
],
"title": "TimePeriodFieldFilterEndsBeforeStartOf",
"type": "object"
},
"TimePeriodFieldFilterStartAfter": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"type": {
"const": "startAfter",
"type": "string"
}
},
"required": [
"date",
"type"
],
"title": "TimePeriodFieldFilterStartAfter",
"type": "object"
},
"TimePeriodFieldFilterStartAfterOrOn": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"type": {
"const": "startAfterOrOn",
"type": "string"
}
},
"required": [
"date",
"type"
],
"title": "TimePeriodFieldFilterStartAfterOrOn",
"type": "object"
},
"TimePeriodFieldFilterStartsAfterEndOf": {
"properties": {
"timePeriod": {
"$ref": "#/components/schemas/TimePeriodRef"
},
"type": {
"const": "startsAfterEndOf",
"type": "string"
}
},
"required": [
"timePeriod",
"type"
],
"title": "TimePeriodFieldFilterStartsAfterEndOf",
"type": "object"
},
"TimePeriodFieldFilterStartsFromStartOf": {
"properties": {
"timePeriod": {
"$ref": "#/components/schemas/TimePeriodRef"
},
"type": {
"const": "startsFromStartOf",
"type": "string"
}
},
"required": [
"timePeriod",
"type"
],
"title": "TimePeriodFieldFilterStartsFromStartOf",
"type": "object"
},
"TimePeriodFieldSettings": {
"discriminator": {
"mapping": {
"iterations": "#/components/schemas/TimePeriodFieldSettingsIterations",
"simple": "#/components/schemas/TimePeriodFieldSettingsSimple"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/TimePeriodFieldSettingsIterations"
},
{
"$ref": "#/components/schemas/TimePeriodFieldSettingsSimple"
}
],
"title": "TimePeriodFieldSettings"
},
"TimePeriodFieldSettingsIterations": {
"properties": {
"currentId": {
"format": "uuid",
"type": "string"
},
"multi": {
"type": "boolean"
},
"timePeriods": {
"items": {
"$ref": "#/components/schemas/TimePeriod"
},
"type": "array"
},
"type": {
"const": "iterations",
"type": "string"
}
},
"required": [
"timePeriods",
"currentId",
"multi",
"type"
],
"title": "TimePeriodFieldSettingsIterations",
"type": "object"
},
"TimePeriodFieldSettingsSimple": {
"properties": {
"multi": {
"type": "boolean"
},
"timePeriods": {
"items": {
"$ref": "#/components/schemas/TimePeriod"
},
"type": "array"
},
"type": {
"const": "simple",
"type": "string"
}
},
"required": [
"timePeriods",
"multi",
"type"
],
"title": "TimePeriodFieldSettingsSimple",
"type": "object"
},
"TimePeriodFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/TimePeriodFieldSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "time-period",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "TimePeriodFieldWithFieldEmbed",
"type": "object"
},
"TimePeriodRef": {
"discriminator": {
"mapping": {
"current": "#/components/schemas/TimePeriodRefCurrent",
"id": "#/components/schemas/TimePeriodRefId"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/TimePeriodRefCurrent"
},
{
"$ref": "#/components/schemas/TimePeriodRefId"
}
],
"title": "TimePeriodRef"
},
"TimePeriodRefCurrent": {
"properties": {
"type": {
"const": "current",
"type": "string"
}
},
"required": [
"type"
],
"title": "TimePeriodRefCurrent",
"type": "object"
},
"TimePeriodRefId": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "id",
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "TimePeriodRefId",
"type": "object"
},
"TimelineViewTypeArrangement": {
"default": "dense",
"enum": [
"dense",
"waterfall"
],
"title": "TimelineViewTypeArrangement",
"type": "string"
},
"TimelineViewTypeDependencyMode": {
"enum": [
"auto"
],
"title": "TimelineViewTypeDependencyMode",
"type": "string"
},
"TimelineViewTypeSettings": {
"properties": {
"arrangement": {
"$ref": "#/components/schemas/TimelineViewTypeArrangement"
},
"colorMode": {
"$ref": "#/components/schemas/ColorMode"
},
"dependencyMode": {
"$ref": "#/components/schemas/TimelineViewTypeDependencyMode"
},
"fadePast": {
"default": false,
"type": "boolean"
},
"groupBy": {
"default": [],
"items": {
"$ref": "#/components/schemas/GroupBy"
},
"type": "array"
},
"showAlias": {
"default": false,
"type": "boolean"
},
"showAssignees": {
"default": false,
"type": "boolean"
},
"showChildItems": {
"default": true,
"type": "boolean"
},
"showCreatedAt": {
"default": false,
"type": "boolean"
},
"showDependencies": {
"default": false,
"type": "boolean"
},
"showFieldIds": {
"default": [],
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"showFieldTypes": {
"default": [],
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"showIntegrations": {
"default": false,
"type": "boolean"
},
"showItemTooltip": {
"default": true,
"type": "boolean"
},
"showLastUpdatedAt": {
"default": false,
"type": "boolean"
},
"showMilestones": {
"default": false,
"type": "boolean"
},
"showParentItems": {
"default": false,
"type": "boolean"
},
"showProgress": {
"default": true,
"type": "boolean"
},
"showStatus": {
"default": true,
"type": "boolean"
},
"timingFieldId": {
"format": "uuid",
"type": "string"
},
"zoom": {
"$ref": "#/components/schemas/TimelineViewTypeZoom"
}
},
"required": [
"timingFieldId"
],
"title": "TimelineViewTypeSettings",
"type": "object"
},
"TimelineViewTypeZoom": {
"default": "monthly",
"enum": [
"daily",
"monthly",
"quarterly",
"weekly",
"yearly"
],
"title": "TimelineViewTypeZoom",
"type": "string"
},
"TimelineViewWithViewEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/ViewEmbed"
},
"description": {
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isPrivate": {
"type": "boolean"
},
"itemFilter": {
"$ref": "#/components/schemas/ItemSearchQueryFilter",
"examples": [
{
"_coproduct": "ItemSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"type": "assignees:defined"
}
],
"type": "and"
}
]
},
"itemScopeLimit": {
"$ref": "#/components/schemas/ItemScopeLimit"
},
"itemSort": {
"items": {
"$ref": "#/components/schemas/ItemSearchQuerySort"
},
"type": "array"
},
"name": {
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"pinnedToPosition": {
"format": "int32",
"type": "integer"
},
"settings": {
"$ref": "#/components/schemas/TimelineViewTypeSettings"
},
"typeId": {
"const": "timeline",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"workspaceId",
"typeId",
"settings",
"name",
"description",
"itemSort",
"order",
"isPrivate",
"_embedded"
],
"title": "TimelineViewWithViewEmbed",
"type": "object"
},
"TrelloIntegrationSummary": {
"properties": {
"capabilities": {
"$ref": "#/components/schemas/IntegrationCapabilities"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"lastSyncAt": {
"format": "date-time",
"type": "string"
},
"lastSyncState": {
"$ref": "#/components/schemas/IntegrationSyncState"
},
"settings": {
"$ref": "#/components/schemas/TrelloIntegrationTypeSettings"
},
"typeId": {
"const": "trello",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"createdAt",
"capabilities",
"enabled"
],
"title": "TrelloIntegrationSummary",
"type": "object"
},
"TrelloIntegrationTypeSettings": {
"properties": {
"addLabel": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"autoSync": {
"type": "boolean"
},
"mapNumberFieldAndVotesCount": {
"format": "uuid",
"type": "string"
},
"mappings": {
"default": [],
"items": {
"$ref": "#/components/schemas/MappingSettingsIntegrationMappingSettings"
},
"type": "array"
},
"removeExtraneous": {
"type": "boolean"
},
"selectBoard": {
"type": "string"
},
"selectLabels": {
"items": {
"type": "string"
},
"type": "array"
},
"selectLists": {
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"type": "string"
},
"token": {
"type": "string"
},
"twoWay": {
"type": "boolean"
}
},
"required": [
"removeExtraneous",
"twoWay",
"autoSync"
],
"title": "TrelloIntegrationTypeSettings",
"type": "object"
},
"UpdateItemAttachmentRequest": {
"properties": {
"contentType": {
"description": "Type of uploaded content.",
"type": "string"
},
"name": {
"description": "Name of the attachment, e.g. its file name (to be displayed in UI).",
"type": "string"
},
"uri": {
"description": "URI of the attachment contents. It can be any URI, but conventionally it's a relative URI like 'attachment:1ecb9ecd-8a97-403a-a74a-741eb4b8fb69' with UUID of a file uploaded to airfocus file-storage. Such URI is then resolved by clients into a full HTTPS URL.",
"type": "string"
}
},
"required": [
"name",
"uri",
"contentType"
],
"title": "UpdateItemAttachmentRequest",
"type": "object"
},
"UpdateItemLinkRequest": {
"properties": {
"fromItemId": {
"format": "uuid",
"type": "string"
},
"fromOrder": {
"description": "How this item-link is ordered in the list of links of the \"fromItem\".",
"format": "int32",
"type": "integer"
},
"toItemId": {
"format": "uuid",
"type": "string"
},
"toOrder": {
"description": "How this item-link is ordered in the list of links of the \"toItem\".",
"format": "int32",
"type": "integer"
},
"typeId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"fromItemId",
"toItemId",
"typeId",
"fromOrder",
"toOrder"
],
"title": "UpdateItemLinkRequest",
"type": "object"
},
"UpdateItemLinkTypeRequest": {
"description": "Custom item link type that defines how items can be related in both directions",
"properties": {
"backwardsName": {
"description": "The name of the link type used in the backward direction (\"{to} {backwards_name} {from}\"), e.g., \"is blocked by\" in \"B-34 is blocked by A-12\". Must contain at least one letter or digit.",
"type": "string"
},
"name": {
"description": "The name of the link type used in the forward direction (\"{from} {name} {to}\"), e.g., \"blocks\" in \"A-12 blocks B-34\". Must contain at least one letter or digit.",
"type": "string"
}
},
"required": [
"name",
"backwardsName"
],
"title": "UpdateItemLinkTypeRequest",
"type": "object"
},
"UpdateItemRequest": {
"properties": {
"archived": {
"default": false,
"description": "Whether this item is archived.",
"type": "boolean"
},
"assigneeUserGroupIds": {
"description": "Ids of user groups that are assigned to this item.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"assigneeUserIds": {
"description": "Ids of users who are assigned to this item.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"color": {
"$ref": "#/components/schemas/ItemColor",
"description": "Color of this item."
},
"description": {
"$ref": "#/components/schemas/RichText",
"description": "Rich-text description of this item."
},
"fields": {
"additionalProperties": {},
"description": "Values of custom fields, where each key is a custom-field ID and each value is a JSON-formatted value of the corresponding field.",
"examples": [
{
"0fc3cfbc-27e9-3ea6-8a78-7de13dae3e3c": {
"number": 42
},
"34f05b62-dd43-3e1e-82bc-b0acabd0d004": {
"boolean": true
},
"5396681e-ea50-3d63-9ae3-c9f8ca17b7d8": {
"userGroupIds": [
"70e2b87a-b774-3022-9ef0-e55031a1c4fb"
],
"userIds": [
"24c9e15e-52af-347c-a25b-757e7bee1f9d"
]
},
"75fe57ec-4a04-3a30-8cac-5f27223df81a": {
"dateRange": {
"endDate": "2024-02-14",
"startDate": "2024-01-14",
"timezone": "UTC"
}
},
"8be74552-df93-331b-bdd6-b36ed74bdb6a": {
"selection": [
"2bb225ce-b5ee-3493-967c-fde0d72da242"
]
},
"c7824f3d-4d5f-3b2f-a2d0-34758c1e9454": {
"text": "A platform built for the new way of doing product management"
},
"e34d514f-7db5-38aa-872a-7c8191a09617": {
"date": {
"date": "2024-01-01",
"timezone": "UTC"
}
}
}
],
"type": "object"
},
"name": {
"description": "Name (title) of this item.",
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"statusId": {
"description": "Id of the status of this item.",
"format": "uuid",
"type": "string"
}
},
"required": [
"statusId",
"color",
"name",
"description",
"assigneeUserIds",
"assigneeUserGroupIds",
"fields",
"order"
],
"title": "UpdateItemRequest",
"type": "object"
},
"UpdateItemRequestWithMD": {
"description": "Item with Markdown string description.",
"properties": {
"archived": {
"default": false,
"description": "Whether this item is archived.",
"type": "boolean"
},
"assigneeUserGroupIds": {
"description": "Ids of user groups that are assigned to this item.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"assigneeUserIds": {
"description": "Ids of users who are assigned to this item.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"color": {
"$ref": "#/components/schemas/ItemColor",
"description": "Color of this item."
},
"description": {
"description": "Rich text content as a markdown string (used with markdown media types)",
"examples": [
"hello **world**!"
],
"type": "string"
},
"fields": {
"additionalProperties": {},
"description": "Values of custom fields, where each key is a custom-field ID and each value is a JSON-formatted value of the corresponding field.",
"examples": [
{
"0fc3cfbc-27e9-3ea6-8a78-7de13dae3e3c": {
"number": 42
},
"34f05b62-dd43-3e1e-82bc-b0acabd0d004": {
"boolean": true
},
"5396681e-ea50-3d63-9ae3-c9f8ca17b7d8": {
"userGroupIds": [
"70e2b87a-b774-3022-9ef0-e55031a1c4fb"
],
"userIds": [
"24c9e15e-52af-347c-a25b-757e7bee1f9d"
]
},
"75fe57ec-4a04-3a30-8cac-5f27223df81a": {
"dateRange": {
"endDate": "2024-02-14",
"startDate": "2024-01-14",
"timezone": "UTC"
}
},
"8be74552-df93-331b-bdd6-b36ed74bdb6a": {
"selection": [
"2bb225ce-b5ee-3493-967c-fde0d72da242"
]
},
"c7824f3d-4d5f-3b2f-a2d0-34758c1e9454": {
"text": "A platform built for the new way of doing product management"
},
"e34d514f-7db5-38aa-872a-7c8191a09617": {
"date": {
"date": "2024-01-01",
"timezone": "UTC"
}
}
}
],
"type": "object"
},
"name": {
"description": "Name (title) of this item.",
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"statusId": {
"description": "Id of the status of this item.",
"format": "uuid",
"type": "string"
}
},
"required": [
"statusId",
"color",
"name",
"description",
"assigneeUserIds",
"assigneeUserGroupIds",
"fields",
"order"
],
"title": "UpdateItemRequestWithMD",
"type": "object"
},
"UpdateMilestoneRequest": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"timezone": {
"type": "string"
}
},
"required": [
"name",
"description",
"date"
],
"title": "UpdateMilestoneRequest",
"type": "object"
},
"UpdateStatusPresetRequest": {
"properties": {
"name": {
"description": "Updated name of the status preset.",
"type": "string"
}
},
"title": "UpdateStatusPresetRequest",
"type": "object"
},
"UpdateStatusPresetStatusesRequest": {
"properties": {
"replacements": {
"additionalProperties": {
"format": "uuid",
"type": "string"
},
"description": "A map of status replacements, where key is an OLD status-id and value is a NEW status-id. Replacements must be specified for each status being deleted from the workspace. This mapping will be used to migrate all items in the workspace to new statuses before deleting the old ones.",
"type": "object"
},
"statuses": {
"description": "Updated list of statuses for this preset.",
"items": {
"$ref": "#/components/schemas/Status"
},
"type": "array"
}
},
"required": [
"statuses",
"replacements"
],
"title": "UpdateStatusPresetStatusesRequest",
"type": "object"
},
"UpdateTeamFlagsRequest": {
"properties": {
"enableAi": {
"type": "boolean"
},
"enableMcpServer": {
"type": "boolean"
},
"enableOkrApp": {
"type": "boolean"
},
"forbidShareLinkCreation": {
"type": "boolean"
},
"removeBranding": {
"type": "boolean"
},
"requirePortalLogin": {
"type": "boolean"
},
"requirePortalPassword": {
"type": "boolean"
},
"requireShareLinkPassword": {
"type": "boolean"
},
"restrictIntegrationManagement": {
"type": "boolean"
},
"restrictShareLinkCreation": {
"type": "boolean"
}
},
"title": "UpdateTeamFlagsRequest",
"type": "object"
},
"UpdateUserRequest": {
"properties": {
"avatarAttachmentId": {
"format": "uuid",
"type": "string"
},
"email": {
"type": "string"
},
"fullName": {
"type": "string"
}
},
"required": [
"email",
"fullName"
],
"title": "UpdateUserRequest",
"type": "object"
},
"UpdateWorkspaceRequest": {
"properties": {
"alias": {
"description": "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.",
"type": "string"
},
"assigneeSettings": {
"$ref": "#/components/schemas/WorkspaceAssigneeSettings"
},
"defaultPermission": {
"$ref": "#/components/schemas/Permission",
"description": "Default permission for all the team members in this workspace. Note: the final permission can be adjusted corresponding to each user's role, e.g. contributors can't have more than Comment permission."
},
"description": {
"$ref": "#/components/schemas/RichText",
"description": "Description of this workspace."
},
"itemColor": {
"$ref": "#/components/schemas/ItemColor",
"description": "Default color applied to newly created items in this workspace. If not defined - a random color will be assigned to each new item."
},
"itemType": {
"$ref": "#/components/schemas/ItemType",
"description": "Type of items in this workspace."
},
"lastActivity": {
"description": "Timestamp of when any entities related to this workspace were last changed.",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of this workspace.",
"type": "string"
},
"order": {
"description": "Order number of this workspace for sorting.",
"format": "int32",
"type": "integer"
},
"progressMode": {
"$ref": "#/components/schemas/WorkspaceProgressMode",
"default": "count"
},
"statusPresetId": {
"description": "Optional reference to a shared status preset. When set, statuses are read from the preset instead of workspace-specific statuses.",
"format": "uuid",
"type": "string"
}
},
"required": [
"name",
"description",
"lastActivity",
"order"
],
"title": "UpdateWorkspaceRequest",
"type": "object"
},
"UpdateWorkspaceRequestWithMD": {
"description": "Workspace with Markdown string description.",
"properties": {
"alias": {
"description": "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.",
"type": "string"
},
"assigneeSettings": {
"$ref": "#/components/schemas/WorkspaceAssigneeSettings"
},
"defaultPermission": {
"$ref": "#/components/schemas/Permission",
"description": "Default permission for all the team members in this workspace. Note: the final permission can be adjusted corresponding to each user's role, e.g. contributors can't have more than Comment permission."
},
"description": {
"description": "Rich text content as a markdown string (used with markdown media types)",
"examples": [
"hello **world**!"
],
"type": "string"
},
"itemColor": {
"$ref": "#/components/schemas/ItemColor",
"description": "Default color applied to newly created items in this workspace. If not defined - a random color will be assigned to each new item."
},
"itemType": {
"$ref": "#/components/schemas/ItemType",
"description": "Type of items in this workspace."
},
"lastActivity": {
"description": "Timestamp of when any entities related to this workspace were last changed.",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of this workspace.",
"type": "string"
},
"order": {
"description": "Order number of this workspace for sorting.",
"format": "int32",
"type": "integer"
},
"progressMode": {
"$ref": "#/components/schemas/WorkspaceProgressMode",
"default": "count"
},
"statusPresetId": {
"description": "Optional reference to a shared status preset. When set, statuses are read from the preset instead of workspace-specific statuses.",
"format": "uuid",
"type": "string"
}
},
"required": [
"name",
"description",
"lastActivity",
"order"
],
"title": "UpdateWorkspaceRequestWithMD",
"type": "object"
},
"User": {
"properties": {
"avatarAttachmentId": {
"format": "uuid",
"type": "string"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"disabled": {
"type": "boolean"
},
"email": {
"type": "string"
},
"emailVerified": {
"type": "boolean"
},
"fullName": {
"type": "string"
},
"isScimUser": {
"description": "Indicates whether the user was provisioned via SCIM. If synced from SCIM, users are restricted from editing their profile information.",
"type": "boolean"
},
"isTeamCreator": {
"type": "boolean"
},
"lastSeenAt": {
"format": "date-time",
"type": "string"
},
"role": {
"$ref": "#/components/schemas/Role"
},
"state": {
"$ref": "#/components/schemas/UserState"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"type": "string"
},
"userId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"userId",
"teamId",
"email",
"fullName",
"role",
"state",
"isTeamCreator",
"isScimUser",
"disabled",
"emailVerified",
"createdAt",
"updatedAt"
],
"title": "User",
"type": "object"
},
"UserRef": {
"discriminator": {
"mapping": {
"current": "#/components/schemas/UserRefUserRefCurrent",
"groupId": "#/components/schemas/UserRefUserGroupRefId",
"id": "#/components/schemas/UserRefUserRefId"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/UserRefUserGroupRefId"
},
{
"$ref": "#/components/schemas/UserRefUserRefCurrent"
},
{
"$ref": "#/components/schemas/UserRefUserRefId"
}
],
"title": "UserRef"
},
"UserRefUserGroupRefId": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "groupId",
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "UserRefUserGroupRefId",
"type": "object"
},
"UserRefUserRefCurrent": {
"properties": {
"type": {
"const": "current",
"type": "string"
}
},
"required": [
"type"
],
"title": "UserRefUserRefCurrent",
"type": "object"
},
"UserRefUserRefId": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "id",
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "UserRefUserRefId",
"type": "object"
},
"UserState": {
"properties": {
"pending": {
"type": "boolean"
},
"unseated": {
"type": "boolean"
}
},
"required": [
"unseated",
"pending"
],
"title": "UserState",
"type": "object"
},
"ViewEmbed": {
"properties": {
"currentPermission": {
"$ref": "#/components/schemas/ViewPermission"
},
"userGroupPermissions": {
"additionalProperties": {
"$ref": "#/components/schemas/ViewPermission"
},
"type": "object"
},
"userPermissions": {
"additionalProperties": {
"$ref": "#/components/schemas/ViewPermission"
},
"type": "object"
}
},
"required": [
"userPermissions",
"userGroupPermissions",
"currentPermission"
],
"title": "ViewEmbed",
"type": "object"
},
"ViewMode": {
"discriminator": {
"mapping": {
"app": "#/components/schemas/ViewModeApp"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ViewModeApp"
}
],
"title": "ViewMode"
},
"ViewModeApp": {
"properties": {
"appTypeId": {
"type": "string"
},
"type": {
"const": "app",
"type": "string"
}
},
"required": [
"appTypeId",
"type"
],
"title": "ViewModeApp",
"type": "object"
},
"ViewPermission": {
"enum": [
"manage",
"view"
],
"title": "ViewPermission",
"type": "string"
},
"ViewSettingsField": {
"discriminator": {
"mapping": {
"fieldId": "#/components/schemas/ViewSettingsFieldFieldId",
"status": "#/components/schemas/ViewSettingsFieldStatus",
"statusCategory": "#/components/schemas/ViewSettingsFieldStatusCategory"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/ViewSettingsFieldFieldId"
},
{
"$ref": "#/components/schemas/ViewSettingsFieldStatus"
},
{
"$ref": "#/components/schemas/ViewSettingsFieldStatusCategory"
}
],
"title": "ViewSettingsField"
},
"ViewSettingsFieldFieldId": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "fieldId",
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "ViewSettingsFieldFieldId",
"type": "object"
},
"ViewSettingsFieldStatus": {
"properties": {
"type": {
"const": "status",
"type": "string"
}
},
"required": [
"type"
],
"title": "ViewSettingsFieldStatus",
"type": "object"
},
"ViewSettingsFieldStatusCategory": {
"properties": {
"type": {
"const": "statusCategory",
"type": "string"
}
},
"required": [
"type"
],
"title": "ViewSettingsFieldStatusCategory",
"type": "object"
},
"ViewWithViewEmbed": {
"discriminator": {
"mapping": {
"board": "#/components/schemas/BoardViewWithViewEmbed",
"chart": "#/components/schemas/ChartViewWithViewEmbed",
"dashboard": "#/components/schemas/DashboardViewWithViewEmbed",
"document": "#/components/schemas/DocumentViewWithViewEmbed",
"embed": "#/components/schemas/EmbedViewWithViewEmbed",
"gantt": "#/components/schemas/GanttViewWithViewEmbed",
"inbox": "#/components/schemas/InboxViewWithViewEmbed",
"list": "#/components/schemas/ListViewWithViewEmbed",
"table": "#/components/schemas/TableViewWithViewEmbed",
"timeline": "#/components/schemas/TimelineViewWithViewEmbed"
},
"propertyName": "typeId"
},
"oneOf": [
{
"$ref": "#/components/schemas/BoardViewWithViewEmbed"
},
{
"$ref": "#/components/schemas/ChartViewWithViewEmbed"
},
{
"$ref": "#/components/schemas/DashboardViewWithViewEmbed"
},
{
"$ref": "#/components/schemas/DocumentViewWithViewEmbed"
},
{
"$ref": "#/components/schemas/EmbedViewWithViewEmbed"
},
{
"$ref": "#/components/schemas/GanttViewWithViewEmbed"
},
{
"$ref": "#/components/schemas/InboxViewWithViewEmbed"
},
{
"$ref": "#/components/schemas/ListViewWithViewEmbed"
},
{
"$ref": "#/components/schemas/TableViewWithViewEmbed"
},
{
"$ref": "#/components/schemas/TimelineViewWithViewEmbed"
}
],
"title": "ViewWithViewEmbed"
},
"VotesField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "votes",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "VotesField",
"type": "object"
},
"VotesFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "votes",
"type": "string"
}
},
"required": [
"id",
"typeId",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "VotesFieldWithFieldEmbed",
"type": "object"
},
"VotingApp": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"settings": {
"$ref": "#/components/schemas/VotingAppTypeSettings"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "voting",
"type": "string"
}
},
"required": [
"id",
"teamId",
"typeId",
"settings"
],
"title": "VotingApp",
"type": "object"
},
"VotingAppAudience": {
"discriminator": {
"mapping": {
"anonymousUsers": "#/components/schemas/VotingAppAudienceAnonymousUsers",
"teamMembers": "#/components/schemas/VotingAppAudienceTeamMembers"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/VotingAppAudienceAnonymousUsers"
},
{
"$ref": "#/components/schemas/VotingAppAudienceTeamMembers"
}
],
"title": "VotingAppAudience"
},
"VotingAppAudienceAnonymousUsers": {
"properties": {
"type": {
"const": "anonymousUsers",
"type": "string"
}
},
"required": [
"type"
],
"title": "VotingAppAudienceAnonymousUsers",
"type": "object"
},
"VotingAppAudienceTeamMembers": {
"properties": {
"type": {
"const": "teamMembers",
"type": "string"
}
},
"required": [
"type"
],
"title": "VotingAppAudienceTeamMembers",
"type": "object"
},
"VotingAppReactionType": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"title": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"required": [
"id",
"title",
"weight"
],
"title": "VotingAppReactionType",
"type": "object"
},
"VotingAppScoreFieldTypeSettings": {
"properties": {
"maximum": {
"type": "number"
},
"minimum": {
"type": "number"
}
},
"title": "VotingAppScoreFieldTypeSettings",
"type": "object"
},
"VotingAppTypeSettings": {
"properties": {
"allowedReactions": {
"items": {
"$ref": "#/components/schemas/VotingAppReactionType"
},
"type": "array"
},
"audience": {
"items": {
"$ref": "#/components/schemas/VotingAppAudience"
},
"type": "array"
},
"scoreFieldId": {
"format": "uuid",
"type": "string"
},
"showCountsForPublic": {
"type": "boolean"
},
"votesFieldId": {
"format": "uuid",
"type": "string"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"workspaceId",
"votesFieldId",
"scoreFieldId",
"allowedReactions",
"audience",
"showCountsForPublic"
],
"title": "VotingAppTypeSettings",
"type": "object"
},
"VotingAppVotesFieldTypeFilter": {
"discriminator": {
"mapping": {
"containsAllUsers": "#/components/schemas/VotingAppVotesFieldTypeFilterContainsAllUsers",
"containsAnyUsers": "#/components/schemas/VotingAppVotesFieldTypeFilterContainsAnyUsers",
"defined": "#/components/schemas/VotingAppVotesFieldTypeFilterDefined"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/VotingAppVotesFieldTypeFilterContainsAllUsers"
},
{
"$ref": "#/components/schemas/VotingAppVotesFieldTypeFilterContainsAnyUsers"
},
{
"$ref": "#/components/schemas/VotingAppVotesFieldTypeFilterDefined"
}
],
"title": "VotingAppVotesFieldTypeFilter"
},
"VotingAppVotesFieldTypeFilterContainsAllUsers": {
"properties": {
"ids": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"type": {
"const": "containsAllUsers",
"type": "string"
}
},
"required": [
"ids",
"type"
],
"title": "VotingAppVotesFieldTypeFilterContainsAllUsers",
"type": "object"
},
"VotingAppVotesFieldTypeFilterContainsAnyUsers": {
"properties": {
"ids": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"type": {
"const": "containsAnyUsers",
"type": "string"
}
},
"required": [
"ids",
"type"
],
"title": "VotingAppVotesFieldTypeFilterContainsAnyUsers",
"type": "object"
},
"VotingAppVotesFieldTypeFilterDefined": {
"properties": {
"type": {
"const": "defined",
"type": "string"
}
},
"required": [
"type"
],
"title": "VotingAppVotesFieldTypeFilterDefined",
"type": "object"
},
"VotingScoreField": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/VotingAppScoreFieldTypeSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "votingScore",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required"
],
"title": "VotingScoreField",
"type": "object"
},
"VotingScoreFieldWithFieldEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/FieldEmbed"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"description": {
"type": "string"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isTeamField": {
"type": "boolean"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"settings": {
"$ref": "#/components/schemas/VotingAppScoreFieldTypeSettings"
},
"teamFieldOrder": {
"format": "int32",
"type": "integer"
},
"teamId": {
"format": "uuid",
"type": "string"
},
"typeId": {
"const": "votingScore",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"name",
"description",
"isTeamField",
"teamId",
"createdAt",
"required",
"_embedded"
],
"title": "VotingScoreFieldWithFieldEmbed",
"type": "object"
},
"WebhookEventFilter": {
"discriminator": {
"mapping": {
"itemCreated": "#/components/schemas/WebhookEventFilterItemCreated",
"itemFieldUpdated": "#/components/schemas/WebhookEventFilterItemFieldUpdated",
"itemRelationChanged": "#/components/schemas/WebhookEventFilterItemRelationChanged",
"itemStatusUpdated": "#/components/schemas/WebhookEventFilterItemStatusUpdated"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/WebhookEventFilterItemCreated"
},
{
"$ref": "#/components/schemas/WebhookEventFilterItemFieldUpdated"
},
{
"$ref": "#/components/schemas/WebhookEventFilterItemRelationChanged"
},
{
"$ref": "#/components/schemas/WebhookEventFilterItemStatusUpdated"
}
],
"title": "WebhookEventFilter"
},
"WebhookEventFilterItemCreated": {
"properties": {
"type": {
"const": "itemCreated",
"type": "string"
}
},
"required": [
"type"
],
"title": "WebhookEventFilterItemCreated",
"type": "object"
},
"WebhookEventFilterItemFieldUpdated": {
"properties": {
"fieldId": {
"format": "uuid",
"type": "string"
},
"type": {
"const": "itemFieldUpdated",
"type": "string"
}
},
"required": [
"fieldId",
"type"
],
"title": "WebhookEventFilterItemFieldUpdated",
"type": "object"
},
"WebhookEventFilterItemRelationChanged": {
"properties": {
"type": {
"const": "itemRelationChanged",
"type": "string"
}
},
"required": [
"type"
],
"title": "WebhookEventFilterItemRelationChanged",
"type": "object"
},
"WebhookEventFilterItemStatusUpdated": {
"properties": {
"type": {
"const": "itemStatusUpdated",
"type": "string"
}
},
"required": [
"type"
],
"title": "WebhookEventFilterItemStatusUpdated",
"type": "object"
},
"WebhookIntegrationSummary": {
"properties": {
"capabilities": {
"$ref": "#/components/schemas/IntegrationCapabilities"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"lastSyncAt": {
"format": "date-time",
"type": "string"
},
"lastSyncState": {
"$ref": "#/components/schemas/IntegrationSyncState"
},
"settings": {
"$ref": "#/components/schemas/WebhookIntegrationTypeSettings"
},
"typeId": {
"const": "webhook",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"createdAt",
"capabilities",
"enabled"
],
"title": "WebhookIntegrationSummary",
"type": "object"
},
"WebhookIntegrationTypeSettings": {
"properties": {
"events": {
"items": {
"$ref": "#/components/schemas/WebhookEventFilter"
},
"type": "array"
},
"headers": {
"default": [],
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
},
"inputFormat": {
"$ref": "#/components/schemas/InputFormat"
},
"method": {
"default": "POST",
"type": "string"
},
"template": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"url",
"events"
],
"title": "WebhookIntegrationTypeSettings",
"type": "object"
},
"WidgetPeriod": {
"oneOf": [
{
"enum": [
"14d",
"180d",
"1y",
"30d",
"90d"
],
"type": "string"
},
{
"description": "A custom date to begin the period in \"custom-start|YYYY-MM-DD\" format or a date range in \"custom-date|YYYY-MM-DD|YYYY-MM-DD\" format.",
"pattern": "^custom-date|\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])|\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$",
"type": "string"
}
],
"title": "WidgetPeriod"
},
"Workspace": {
"properties": {
"alias": {
"description": "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.",
"type": "string"
},
"assigneeSettings": {
"$ref": "#/components/schemas/WorkspaceAssigneeSettings"
},
"createdAt": {
"description": "Timestamp of when this workspace was created.",
"format": "date-time",
"type": "string"
},
"defaultPermission": {
"$ref": "#/components/schemas/Permission",
"description": "Default permission for all the team members in this workspace. Note: the final permission can be adjusted corresponding to each user's role, e.g. contributors can't have more than Comment permission."
},
"description": {
"$ref": "#/components/schemas/RichText",
"description": "Description of this workspace."
},
"id": {
"description": "Unique identifier of this workspace.",
"format": "uuid",
"type": "string"
},
"itemColor": {
"$ref": "#/components/schemas/ItemColor",
"description": "Default color applied to newly created items in this workspace. If not defined - a random color will be assigned to each new item."
},
"itemType": {
"$ref": "#/components/schemas/ItemType",
"description": "Type of items in this workspace."
},
"lastActivity": {
"description": "Timestamp of when any entities related to this workspace were last changed.",
"format": "date-time",
"type": "string"
},
"lastUpdatedAt": {
"description": "Timestamp of when this workspace was last updated.",
"format": "date-time",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/WorkspaceWorkspaceMetadata",
"description": "Additional metadata about this workspace."
},
"name": {
"description": "Name of this workspace.",
"type": "string"
},
"namespace": {
"$ref": "#/components/schemas/WorkspaceNamespace",
"description": "The system namespace of this workspace."
},
"order": {
"description": "Order number of this workspace for sorting.",
"format": "int32",
"type": "integer"
},
"progressMode": {
"$ref": "#/components/schemas/WorkspaceProgressMode"
},
"statusPresetId": {
"description": "Optional reference to a shared status preset. When set, statuses are read from the preset instead of workspace-specific statuses.",
"format": "uuid",
"type": "string"
},
"teamId": {
"description": "Id of the team this workspace belongs to.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"teamId",
"name",
"description",
"progressMode",
"createdAt",
"lastUpdatedAt",
"lastActivity",
"namespace",
"order"
],
"title": "Workspace",
"type": "object"
},
"WorkspaceAssigneeSettings": {
"default": {
"required": false
},
"description": "Configuration settings for the assignees field in this workspace.",
"properties": {
"required": {
"description": "Whether the assignees field is required when creating or updating items.",
"type": "boolean"
}
},
"required": [
"required"
],
"title": "WorkspaceAssigneeSettings",
"type": "object"
},
"WorkspaceBulkAction": {
"discriminator": {
"mapping": {
"create": "#/components/schemas/WorkspaceBulkCreate",
"delete": "#/components/schemas/WorkspaceBulkDelete",
"patch": "#/components/schemas/WorkspaceBulkPatch",
"update": "#/components/schemas/WorkspaceBulkUpdate"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/WorkspaceBulkCreate"
},
{
"$ref": "#/components/schemas/WorkspaceBulkDelete"
},
{
"$ref": "#/components/schemas/WorkspaceBulkPatch"
},
{
"$ref": "#/components/schemas/WorkspaceBulkUpdate"
}
],
"title": "WorkspaceBulkAction"
},
"WorkspaceBulkCreate": {
"properties": {
"resource": {
"$ref": "#/components/schemas/CreateWorkspaceRequest"
},
"type": {
"enum": [
"create"
],
"type": "string"
}
},
"required": [
"resource",
"type"
],
"title": "WorkspaceBulkCreate",
"type": "object"
},
"WorkspaceBulkDelete": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"type": {
"enum": [
"delete"
],
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "WorkspaceBulkDelete",
"type": "object"
},
"WorkspaceBulkPatch": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"transform": {
"$ref": "#/components/schemas/JsonPatch"
},
"type": {
"enum": [
"patch"
],
"type": "string"
}
},
"required": [
"id",
"transform",
"type"
],
"title": "WorkspaceBulkPatch",
"type": "object"
},
"WorkspaceBulkUpdate": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/UpdateWorkspaceRequest"
},
"type": {
"enum": [
"update"
],
"type": "string"
}
},
"required": [
"id",
"resource",
"type"
],
"title": "WorkspaceBulkUpdate",
"type": "object"
},
"WorkspaceDuplicateRequest": {
"properties": {
"duplicatePermissions": {
"description": "Whether to also duplicate all user-permissions to the new workspace.",
"type": "boolean"
}
},
"required": [
"duplicatePermissions"
],
"title": "WorkspaceDuplicateRequest",
"type": "object"
},
"WorkspaceEmbed": {
"properties": {
"apps": {
"additionalProperties": {
"$ref": "#/components/schemas/App"
},
"type": "object"
},
"children": {
"items": {
"$ref": "#/components/schemas/WorkspaceEmbedRelation"
},
"type": "array"
},
"currentPermission": {
"$ref": "#/components/schemas/Permission"
},
"fields": {
"additionalProperties": {
"$ref": "#/components/schemas/FieldWithFieldEmbed"
},
"type": "object"
},
"integrations": {
"additionalProperties": {
"$ref": "#/components/schemas/IntegrationSummary"
},
"type": "object"
},
"itemCount": {
"format": "int32",
"type": "integer"
},
"itemStatusCount": {
"additionalProperties": {
"format": "int32",
"type": "integer"
},
"type": "object"
},
"itemStatusCountArchived": {
"additionalProperties": {
"format": "int32",
"type": "integer"
},
"type": "object"
},
"parents": {
"items": {
"$ref": "#/components/schemas/WorkspaceEmbedRelation"
},
"type": "array"
},
"permissions": {
"additionalProperties": {
"$ref": "#/components/schemas/Permission"
},
"type": "object"
},
"statuses": {
"additionalProperties": {
"$ref": "#/components/schemas/Status"
},
"type": "object"
},
"userGroupPermissions": {
"additionalProperties": {
"$ref": "#/components/schemas/Permission"
},
"type": "object"
},
"views": {
"additionalProperties": {
"$ref": "#/components/schemas/ViewWithViewEmbed"
},
"type": "object"
},
"workspaceGroup": {
"$ref": "#/components/schemas/WorkspaceEmbedWorkspaceGroup"
}
},
"required": [
"parents",
"children",
"permissions",
"userGroupPermissions",
"itemCount",
"statuses",
"itemStatusCount",
"itemStatusCountArchived",
"fields",
"views",
"integrations",
"apps"
],
"title": "WorkspaceEmbed",
"type": "object"
},
"WorkspaceEmbedRelation": {
"properties": {
"relationId": {
"format": "uuid",
"type": "string"
},
"workspace": {
"$ref": "#/components/schemas/Workspace"
},
"workspaceId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"relationId",
"workspaceId"
],
"title": "WorkspaceEmbedRelation",
"type": "object"
},
"WorkspaceEmbedWorkspaceGroup": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"order": {
"format": "int32",
"type": "integer"
},
"parentId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"name",
"order"
],
"title": "WorkspaceEmbedWorkspaceGroup",
"type": "object"
},
"WorkspaceGroupAssignWorkspaceRequest": {
"description": "Payload to assign a workspace to a workspace-group (or move it to the root when no group is provided).",
"properties": {
"workspaceGroupId": {
"description": "UUID of the target workspace-group. If omitted, the workspace is moved out of any group to the root.",
"format": "uuid",
"type": "string"
},
"workspaceId": {
"description": "UUID of the workspace to assign.",
"format": "uuid",
"type": "string"
}
},
"required": [
"workspaceId"
],
"title": "WorkspaceGroupAssignWorkspaceRequest",
"type": "object"
},
"WorkspaceGroupBulkAction": {
"discriminator": {
"mapping": {
"create": "#/components/schemas/WorkspaceGroupBulkCreate",
"delete": "#/components/schemas/WorkspaceGroupBulkDelete",
"patch": "#/components/schemas/WorkspaceGroupBulkPatch",
"update": "#/components/schemas/WorkspaceGroupBulkUpdate"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/WorkspaceGroupBulkCreate"
},
{
"$ref": "#/components/schemas/WorkspaceGroupBulkDelete"
},
{
"$ref": "#/components/schemas/WorkspaceGroupBulkPatch"
},
{
"$ref": "#/components/schemas/WorkspaceGroupBulkUpdate"
}
],
"title": "WorkspaceGroupBulkAction"
},
"WorkspaceGroupBulkCreate": {
"properties": {
"resource": {
"$ref": "#/components/schemas/WorkspaceGroupParams"
},
"type": {
"enum": [
"create"
],
"type": "string"
}
},
"required": [
"resource",
"type"
],
"title": "WorkspaceGroupBulkCreate",
"type": "object"
},
"WorkspaceGroupBulkDelete": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"type": {
"enum": [
"delete"
],
"type": "string"
}
},
"required": [
"id",
"type"
],
"title": "WorkspaceGroupBulkDelete",
"type": "object"
},
"WorkspaceGroupBulkPatch": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"transform": {
"$ref": "#/components/schemas/JsonPatch"
},
"type": {
"enum": [
"patch"
],
"type": "string"
}
},
"required": [
"id",
"transform",
"type"
],
"title": "WorkspaceGroupBulkPatch",
"type": "object"
},
"WorkspaceGroupBulkUpdate": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/WorkspaceGroupParams"
},
"type": {
"enum": [
"update"
],
"type": "string"
}
},
"required": [
"id",
"resource",
"type"
],
"title": "WorkspaceGroupBulkUpdate",
"type": "object"
},
"WorkspaceGroupEmbed": {
"description": "An object embedded into each workspace-group when retrieving/listing specific workspaces.",
"properties": {
"currentPermission": {
"$ref": "#/components/schemas/Permission",
"description": "Actual permission of the current user for this workspace-group."
},
"permissions": {
"additionalProperties": {
"$ref": "#/components/schemas/Permission"
},
"description": "All explicitly defined permissions for all users for this workspace-group.",
"type": "object"
},
"userGroupPermissions": {
"additionalProperties": {
"$ref": "#/components/schemas/Permission"
},
"description": "All explicitly defined permissions for all user groups for this workspace-group.",
"type": "object"
},
"workspaces": {
"description": "List of workspaces which belongs to this workspace-group.",
"items": {
"$ref": "#/components/schemas/Workspace"
},
"type": "array"
}
},
"required": [
"workspaces",
"permissions",
"userGroupPermissions"
],
"title": "WorkspaceGroupEmbed",
"type": "object"
},
"WorkspaceGroupParams": {
"description": "Payload to create or update a workspace-group.",
"properties": {
"defaultPermission": {
"$ref": "#/components/schemas/Permission",
"description": "Default permission for all team-members to all the inner contents of this group."
},
"name": {
"description": "Name of this group.",
"type": "string"
},
"order": {
"description": "Order number of this group for sorting. If omitted, the group is appended at the end on create and kept as-is on update.",
"format": "int32",
"type": "integer"
},
"parentId": {
"description": "UUID of the parent group (if applicable).",
"format": "uuid",
"type": "string"
}
},
"required": [
"name"
],
"title": "WorkspaceGroupParams",
"type": "object"
},
"WorkspaceGroupPermissionsUpdateRequest": {
"description": "Payload to replace the permissions of a workspace-group for individual users and user-groups.",
"properties": {
"permissions": {
"additionalProperties": {
"$ref": "#/components/schemas/Permission"
},
"description": "Per-user permissions for the workspace-group, keyed by user UUID.",
"type": "object"
},
"userGroupPermissions": {
"additionalProperties": {
"$ref": "#/components/schemas/Permission"
},
"description": "Per-user-group permissions for the workspace-group, keyed by user-group UUID.",
"type": "object"
}
},
"required": [
"permissions",
"userGroupPermissions"
],
"title": "WorkspaceGroupPermissionsUpdateRequest",
"type": "object"
},
"WorkspaceGroupSearchEmbed": {
"description": "An object embedded into each workspace-group when searching workspaces.",
"properties": {
"currentPermission": {
"$ref": "#/components/schemas/Permission",
"description": "Actual permission of the current user for this workspace-group."
},
"permissions": {
"additionalProperties": {
"$ref": "#/components/schemas/Permission"
},
"description": "All explicitly defined permissions for all users for this workspace-group.",
"type": "object"
},
"userGroupPermissions": {
"additionalProperties": {
"$ref": "#/components/schemas/Permission"
},
"description": "All explicitly defined permissions for all user groups for this workspace-group.",
"type": "object"
},
"workspaceIds": {
"description": "List of workspace-ids which belongs to this workspace-group.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"workspaces": {
"deprecated": true,
"description": "Deprecated and will be removed. Use 'workspaceIds' instead, and a followup workspace-search request.",
"items": {
"$ref": "#/components/schemas/Workspace"
},
"type": "array"
}
},
"required": [
"workspaceIds",
"workspaces",
"permissions",
"userGroupPermissions"
],
"title": "WorkspaceGroupSearchEmbed",
"type": "object"
},
"WorkspaceGroupSearchQuery": {
"title": "WorkspaceGroupSearchQuery",
"type": "object"
},
"WorkspaceGroupWithWorkspaceGroupEmbed": {
"description": "An entity for grouping workspaces (like folders).",
"properties": {
"_embedded": {
"$ref": "#/components/schemas/WorkspaceGroupEmbed"
},
"createdAt": {
"description": "Date-time when this group was created.",
"format": "date-time",
"type": "string"
},
"defaultPermission": {
"$ref": "#/components/schemas/Permission",
"description": "Default permission for all team-members to all the inner contents of this group."
},
"id": {
"description": "UUID of this group.",
"format": "uuid",
"type": "string"
},
"lastUpdatedAt": {
"description": "Date-time when this group was last updated.",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of this group.",
"type": "string"
},
"order": {
"description": "Order number of this group for sorting.",
"format": "int32",
"type": "integer"
},
"parentId": {
"description": "UUID of the parent group (if applicable).",
"format": "uuid",
"type": "string"
},
"teamId": {
"description": "UUID of the team which owns this group.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"teamId",
"name",
"order",
"createdAt",
"lastUpdatedAt",
"_embedded"
],
"title": "WorkspaceGroupWithWorkspaceGroupEmbed",
"type": "object"
},
"WorkspaceGroupWithWorkspaceGroupEmbedOrNullList": {
"items": {
"$ref": "#/components/schemas/WorkspaceGroupWithWorkspaceGroupEmbed"
},
"title": "WorkspaceGroupWithWorkspaceGroupEmbedOrNullList",
"type": "array"
},
"WorkspaceGroupWithWorkspaceGroupSearchEmbed": {
"description": "An entity for grouping workspaces (like folders).",
"properties": {
"_embedded": {
"$ref": "#/components/schemas/WorkspaceGroupSearchEmbed"
},
"createdAt": {
"description": "Date-time when this group was created.",
"format": "date-time",
"type": "string"
},
"defaultPermission": {
"$ref": "#/components/schemas/Permission",
"description": "Default permission for all team-members to all the inner contents of this group."
},
"id": {
"description": "UUID of this group.",
"format": "uuid",
"type": "string"
},
"lastUpdatedAt": {
"description": "Date-time when this group was last updated.",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of this group.",
"type": "string"
},
"order": {
"description": "Order number of this group for sorting.",
"format": "int32",
"type": "integer"
},
"parentId": {
"description": "UUID of the parent group (if applicable).",
"format": "uuid",
"type": "string"
},
"teamId": {
"description": "UUID of the team which owns this group.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"teamId",
"name",
"order",
"createdAt",
"lastUpdatedAt",
"_embedded"
],
"title": "WorkspaceGroupWithWorkspaceGroupSearchEmbed",
"type": "object"
},
"WorkspaceGroupWithWorkspaceGroupSearchEmbedPage": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/WorkspaceGroupWithWorkspaceGroupSearchEmbed"
},
"type": "array"
},
"totalItems": {
"format": "int32",
"type": "integer"
}
},
"required": [
"items",
"totalItems"
],
"title": "WorkspaceGroupWithWorkspaceGroupSearchEmbedPage",
"type": "object"
},
"WorkspaceNamespace": {
"enum": [
"main",
"app:okr",
"app:portfolio"
],
"title": "WorkspaceNamespace",
"type": "string"
},
"WorkspacePermissionsUpdateRequest": {
"properties": {
"defaultPermission": {
"$ref": "#/components/schemas/Permission"
},
"permissions": {
"additionalProperties": {
"$ref": "#/components/schemas/Permission"
},
"description": "Explicit permissions for specific users in the team.",
"type": "object"
},
"userGroupPermissions": {
"additionalProperties": {
"$ref": "#/components/schemas/Permission"
},
"description": "Explicit permissions for specific teams.",
"type": "object"
}
},
"required": [
"permissions",
"userGroupPermissions"
],
"title": "WorkspacePermissionsUpdateRequest",
"type": "object"
},
"WorkspaceProgressMode": {
"enum": [
"count",
"none",
"percentage"
],
"title": "WorkspaceProgressMode",
"type": "string"
},
"WorkspaceSearchEmbed": {
"properties": {
"currentPermission": {
"$ref": "#/components/schemas/Permission"
},
"itemCount": {
"format": "int32",
"type": "integer"
},
"permissions": {
"additionalProperties": {
"$ref": "#/components/schemas/Permission"
},
"type": "object"
},
"statuses": {
"additionalProperties": {
"$ref": "#/components/schemas/Status"
},
"type": "object"
},
"userGroupPermissions": {
"additionalProperties": {
"$ref": "#/components/schemas/Permission"
},
"type": "object"
}
},
"required": [
"permissions",
"userGroupPermissions",
"statuses",
"itemCount"
],
"title": "WorkspaceSearchEmbed",
"type": "object"
},
"WorkspaceSearchQuery": {
"properties": {
"archived": {
"default": false,
"type": "boolean"
},
"filter": {
"$ref": "#/components/schemas/WorkspaceSearchQueryFilter",
"examples": [
{
"_coproduct": "WorkspaceSearchQueryFilter",
"inner": [
{
"caseSensitive": false,
"text": "foo",
"type": "name:contain"
},
{
"ids": [],
"type": "members:containAny"
}
],
"type": "and"
}
]
},
"sort": {
"$ref": "#/components/schemas/WorkspaceSearchQuerySort"
}
},
"title": "WorkspaceSearchQuery",
"type": "object"
},
"WorkspaceSearchQueryFilter": {
"discriminator": {
"mapping": {
"and": "#/components/schemas/WorkspaceSearchQueryFilterAnd",
"appType:containAny": "#/components/schemas/WorkspaceSearchQueryFilterAppTypeContainAny",
"field:containAny": "#/components/schemas/WorkspaceSearchQueryFilterFieldContainAny",
"itemType:containAny": "#/components/schemas/WorkspaceSearchQueryFilterItemTypeContainAny",
"members:containAny": "#/components/schemas/WorkspaceSearchQueryFilterMembersContainAny",
"name:contain": "#/components/schemas/WorkspaceSearchQueryFilterNameContain",
"name:equal": "#/components/schemas/WorkspaceSearchQueryFilterNameEqual",
"namespace:containAny": "#/components/schemas/WorkspaceSearchQueryFilterNamespaceContainAny",
"not": "#/components/schemas/WorkspaceSearchQueryFilterNot",
"or": "#/components/schemas/WorkspaceSearchQueryFilterOr"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/WorkspaceSearchQueryFilterAnd"
},
{
"$ref": "#/components/schemas/WorkspaceSearchQueryFilterAppTypeContainAny"
},
{
"$ref": "#/components/schemas/WorkspaceSearchQueryFilterFieldContainAny"
},
{
"$ref": "#/components/schemas/WorkspaceSearchQueryFilterItemTypeContainAny"
},
{
"$ref": "#/components/schemas/WorkspaceSearchQueryFilterMembersContainAny"
},
{
"$ref": "#/components/schemas/WorkspaceSearchQueryFilterNameContain"
},
{
"$ref": "#/components/schemas/WorkspaceSearchQueryFilterNameEqual"
},
{
"$ref": "#/components/schemas/WorkspaceSearchQueryFilterNamespaceContainAny"
},
{
"$ref": "#/components/schemas/WorkspaceSearchQueryFilterNot"
},
{
"$ref": "#/components/schemas/WorkspaceSearchQueryFilterOr"
}
],
"title": "WorkspaceSearchQueryFilter"
},
"WorkspaceSearchQueryFilterAnd": {
"properties": {
"inner": {
"items": {
"$ref": "#/components/schemas/WorkspaceSearchQueryFilter"
},
"type": "array"
},
"type": {
"const": "and",
"type": "string"
}
},
"required": [
"inner",
"type"
],
"title": "WorkspaceSearchQueryFilterAnd",
"type": "object"
},
"WorkspaceSearchQueryFilterAppTypeContainAny": {
"properties": {
"type": {
"const": "appType:containAny",
"type": "string"
},
"values": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"values",
"type"
],
"title": "WorkspaceSearchQueryFilterAppTypeContainAny",
"type": "object"
},
"WorkspaceSearchQueryFilterFieldContainAny": {
"properties": {
"type": {
"const": "field:containAny",
"type": "string"
},
"values": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"values",
"type"
],
"title": "WorkspaceSearchQueryFilterFieldContainAny",
"type": "object"
},
"WorkspaceSearchQueryFilterItemTypeContainAny": {
"properties": {
"type": {
"const": "itemType:containAny",
"type": "string"
},
"values": {
"items": {
"$ref": "#/components/schemas/ItemType"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"values",
"type"
],
"title": "WorkspaceSearchQueryFilterItemTypeContainAny",
"type": "object"
},
"WorkspaceSearchQueryFilterMembersContainAny": {
"properties": {
"ids": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"type": {
"const": "members:containAny",
"type": "string"
}
},
"required": [
"ids",
"type"
],
"title": "WorkspaceSearchQueryFilterMembersContainAny",
"type": "object"
},
"WorkspaceSearchQueryFilterNameContain": {
"properties": {
"caseSensitive": {
"type": "boolean"
},
"text": {
"type": "string"
},
"type": {
"const": "name:contain",
"type": "string"
}
},
"required": [
"text",
"caseSensitive",
"type"
],
"title": "WorkspaceSearchQueryFilterNameContain",
"type": "object"
},
"WorkspaceSearchQueryFilterNameEqual": {
"properties": {
"caseSensitive": {
"type": "boolean"
},
"text": {
"type": "string"
},
"type": {
"const": "name:equal",
"type": "string"
}
},
"required": [
"text",
"caseSensitive",
"type"
],
"title": "WorkspaceSearchQueryFilterNameEqual",
"type": "object"
},
"WorkspaceSearchQueryFilterNamespaceContainAny": {
"properties": {
"type": {
"const": "namespace:containAny",
"type": "string"
},
"values": {
"items": {
"$ref": "#/components/schemas/WorkspaceNamespace"
},
"type": "array"
}
},
"required": [
"values",
"type"
],
"title": "WorkspaceSearchQueryFilterNamespaceContainAny",
"type": "object"
},
"WorkspaceSearchQueryFilterNot": {
"properties": {
"inner": {
"$ref": "#/components/schemas/WorkspaceSearchQueryFilter"
},
"type": {
"const": "not",
"type": "string"
}
},
"required": [
"inner",
"type"
],
"title": "WorkspaceSearchQueryFilterNot",
"type": "object"
},
"WorkspaceSearchQueryFilterOr": {
"properties": {
"inner": {
"items": {
"$ref": "#/components/schemas/WorkspaceSearchQueryFilter"
},
"type": "array"
},
"type": {
"const": "or",
"type": "string"
}
},
"required": [
"inner",
"type"
],
"title": "WorkspaceSearchQueryFilterOr",
"type": "object"
},
"WorkspaceSearchQuerySort": {
"default": {
"direction": "desc",
"type": "lastActivity"
},
"discriminator": {
"mapping": {
"createdAt": "#/components/schemas/WorkspaceSearchQuerySortCreatedAt",
"lastActivity": "#/components/schemas/WorkspaceSearchQuerySortLastActivity",
"lastUpdatedAt": "#/components/schemas/WorkspaceSearchQuerySortLastUpdatedAt",
"name": "#/components/schemas/WorkspaceSearchQuerySortName"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/WorkspaceSearchQuerySortCreatedAt"
},
{
"$ref": "#/components/schemas/WorkspaceSearchQuerySortLastActivity"
},
{
"$ref": "#/components/schemas/WorkspaceSearchQuerySortLastUpdatedAt"
},
{
"$ref": "#/components/schemas/WorkspaceSearchQuerySortName"
}
],
"title": "WorkspaceSearchQuerySort"
},
"WorkspaceSearchQuerySortCreatedAt": {
"properties": {
"direction": {
"$ref": "#/components/schemas/WorkspaceSearchQuerySortDirection"
},
"type": {
"const": "createdAt",
"type": "string"
}
},
"required": [
"direction",
"type"
],
"title": "WorkspaceSearchQuerySortCreatedAt",
"type": "object"
},
"WorkspaceSearchQuerySortDirection": {
"enum": [
"asc",
"desc"
],
"title": "WorkspaceSearchQuerySortDirection",
"type": "string"
},
"WorkspaceSearchQuerySortLastActivity": {
"properties": {
"direction": {
"$ref": "#/components/schemas/WorkspaceSearchQuerySortDirection"
},
"type": {
"const": "lastActivity",
"type": "string"
}
},
"required": [
"direction",
"type"
],
"title": "WorkspaceSearchQuerySortLastActivity",
"type": "object"
},
"WorkspaceSearchQuerySortLastUpdatedAt": {
"properties": {
"direction": {
"$ref": "#/components/schemas/WorkspaceSearchQuerySortDirection"
},
"type": {
"const": "lastUpdatedAt",
"type": "string"
}
},
"required": [
"direction",
"type"
],
"title": "WorkspaceSearchQuerySortLastUpdatedAt",
"type": "object"
},
"WorkspaceSearchQuerySortName": {
"properties": {
"direction": {
"$ref": "#/components/schemas/WorkspaceSearchQuerySortDirection"
},
"type": {
"const": "name",
"type": "string"
}
},
"required": [
"direction",
"type"
],
"title": "WorkspaceSearchQuerySortName",
"type": "object"
},
"WorkspaceWithMDWithWorkspaceEmbed": {
"description": "Workspace with Markdown string description.",
"properties": {
"_embedded": {
"$ref": "#/components/schemas/WorkspaceEmbed"
},
"alias": {
"description": "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.",
"type": "string"
},
"assigneeSettings": {
"$ref": "#/components/schemas/WorkspaceAssigneeSettings"
},
"createdAt": {
"description": "Timestamp of when this workspace was created.",
"format": "date-time",
"type": "string"
},
"defaultPermission": {
"$ref": "#/components/schemas/Permission",
"description": "Default permission for all the team members in this workspace. Note: the final permission can be adjusted corresponding to each user's role, e.g. contributors can't have more than Comment permission."
},
"description": {
"description": "Rich text content as a markdown string (used with markdown media types)",
"examples": [
"hello **world**!"
],
"type": "string"
},
"id": {
"description": "Unique identifier of this workspace.",
"format": "uuid",
"type": "string"
},
"itemColor": {
"$ref": "#/components/schemas/ItemColor",
"description": "Default color applied to newly created items in this workspace. If not defined - a random color will be assigned to each new item."
},
"itemType": {
"$ref": "#/components/schemas/ItemType",
"description": "Type of items in this workspace."
},
"lastActivity": {
"description": "Timestamp of when any entities related to this workspace were last changed.",
"format": "date-time",
"type": "string"
},
"lastUpdatedAt": {
"description": "Timestamp of when this workspace was last updated.",
"format": "date-time",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/WorkspaceWorkspaceMetadata",
"description": "Additional metadata about this workspace."
},
"name": {
"description": "Name of this workspace.",
"type": "string"
},
"namespace": {
"$ref": "#/components/schemas/WorkspaceNamespace",
"description": "The system namespace of this workspace."
},
"order": {
"description": "Order number of this workspace for sorting.",
"format": "int32",
"type": "integer"
},
"progressMode": {
"$ref": "#/components/schemas/WorkspaceProgressMode"
},
"statusPresetId": {
"description": "Optional reference to a shared status preset. When set, statuses are read from the preset instead of workspace-specific statuses.",
"format": "uuid",
"type": "string"
},
"teamId": {
"description": "Id of the team this workspace belongs to.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"teamId",
"name",
"description",
"progressMode",
"createdAt",
"lastUpdatedAt",
"lastActivity",
"namespace",
"order",
"_embedded"
],
"title": "WorkspaceWithMDWithWorkspaceEmbed",
"type": "object"
},
"WorkspaceWithMDWithWorkspaceEmbedOrNullList": {
"items": {
"$ref": "#/components/schemas/WorkspaceWithMDWithWorkspaceEmbed"
},
"title": "WorkspaceWithMDWithWorkspaceEmbedOrNullList",
"type": "array"
},
"WorkspaceWithMDWithWorkspaceSearchEmbed": {
"description": "Workspace with Markdown string description.",
"properties": {
"_embedded": {
"$ref": "#/components/schemas/WorkspaceSearchEmbed"
},
"alias": {
"description": "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.",
"type": "string"
},
"assigneeSettings": {
"$ref": "#/components/schemas/WorkspaceAssigneeSettings"
},
"createdAt": {
"description": "Timestamp of when this workspace was created.",
"format": "date-time",
"type": "string"
},
"defaultPermission": {
"$ref": "#/components/schemas/Permission",
"description": "Default permission for all the team members in this workspace. Note: the final permission can be adjusted corresponding to each user's role, e.g. contributors can't have more than Comment permission."
},
"description": {
"description": "Rich text content as a markdown string (used with markdown media types)",
"examples": [
"hello **world**!"
],
"type": "string"
},
"id": {
"description": "Unique identifier of this workspace.",
"format": "uuid",
"type": "string"
},
"itemColor": {
"$ref": "#/components/schemas/ItemColor",
"description": "Default color applied to newly created items in this workspace. If not defined - a random color will be assigned to each new item."
},
"itemType": {
"$ref": "#/components/schemas/ItemType",
"description": "Type of items in this workspace."
},
"lastActivity": {
"description": "Timestamp of when any entities related to this workspace were last changed.",
"format": "date-time",
"type": "string"
},
"lastUpdatedAt": {
"description": "Timestamp of when this workspace was last updated.",
"format": "date-time",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/WorkspaceWorkspaceMetadata",
"description": "Additional metadata about this workspace."
},
"name": {
"description": "Name of this workspace.",
"type": "string"
},
"namespace": {
"$ref": "#/components/schemas/WorkspaceNamespace",
"description": "The system namespace of this workspace."
},
"order": {
"description": "Order number of this workspace for sorting.",
"format": "int32",
"type": "integer"
},
"progressMode": {
"$ref": "#/components/schemas/WorkspaceProgressMode"
},
"statusPresetId": {
"description": "Optional reference to a shared status preset. When set, statuses are read from the preset instead of workspace-specific statuses.",
"format": "uuid",
"type": "string"
},
"teamId": {
"description": "Id of the team this workspace belongs to.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"teamId",
"name",
"description",
"progressMode",
"createdAt",
"lastUpdatedAt",
"lastActivity",
"namespace",
"order",
"_embedded"
],
"title": "WorkspaceWithMDWithWorkspaceSearchEmbed",
"type": "object"
},
"WorkspaceWithMDWithWorkspaceSearchEmbedPage": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/WorkspaceWithMDWithWorkspaceSearchEmbed"
},
"type": "array"
},
"totalItems": {
"format": "int32",
"type": "integer"
}
},
"required": [
"items",
"totalItems"
],
"title": "WorkspaceWithMDWithWorkspaceSearchEmbedPage",
"type": "object"
},
"WorkspaceWithWorkspaceEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/WorkspaceEmbed"
},
"alias": {
"description": "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.",
"type": "string"
},
"assigneeSettings": {
"$ref": "#/components/schemas/WorkspaceAssigneeSettings"
},
"createdAt": {
"description": "Timestamp of when this workspace was created.",
"format": "date-time",
"type": "string"
},
"defaultPermission": {
"$ref": "#/components/schemas/Permission",
"description": "Default permission for all the team members in this workspace. Note: the final permission can be adjusted corresponding to each user's role, e.g. contributors can't have more than Comment permission."
},
"description": {
"$ref": "#/components/schemas/RichText",
"description": "Description of this workspace."
},
"id": {
"description": "Unique identifier of this workspace.",
"format": "uuid",
"type": "string"
},
"itemColor": {
"$ref": "#/components/schemas/ItemColor",
"description": "Default color applied to newly created items in this workspace. If not defined - a random color will be assigned to each new item."
},
"itemType": {
"$ref": "#/components/schemas/ItemType",
"description": "Type of items in this workspace."
},
"lastActivity": {
"description": "Timestamp of when any entities related to this workspace were last changed.",
"format": "date-time",
"type": "string"
},
"lastUpdatedAt": {
"description": "Timestamp of when this workspace was last updated.",
"format": "date-time",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/WorkspaceWorkspaceMetadata",
"description": "Additional metadata about this workspace."
},
"name": {
"description": "Name of this workspace.",
"type": "string"
},
"namespace": {
"$ref": "#/components/schemas/WorkspaceNamespace",
"description": "The system namespace of this workspace."
},
"order": {
"description": "Order number of this workspace for sorting.",
"format": "int32",
"type": "integer"
},
"progressMode": {
"$ref": "#/components/schemas/WorkspaceProgressMode"
},
"statusPresetId": {
"description": "Optional reference to a shared status preset. When set, statuses are read from the preset instead of workspace-specific statuses.",
"format": "uuid",
"type": "string"
},
"teamId": {
"description": "Id of the team this workspace belongs to.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"teamId",
"name",
"description",
"progressMode",
"createdAt",
"lastUpdatedAt",
"lastActivity",
"namespace",
"order",
"_embedded"
],
"title": "WorkspaceWithWorkspaceEmbed",
"type": "object"
},
"WorkspaceWithWorkspaceEmbedOrNullList": {
"items": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbed"
},
"title": "WorkspaceWithWorkspaceEmbedOrNullList",
"type": "array"
},
"WorkspaceWithWorkspaceSearchEmbed": {
"properties": {
"_embedded": {
"$ref": "#/components/schemas/WorkspaceSearchEmbed"
},
"alias": {
"description": "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.",
"type": "string"
},
"assigneeSettings": {
"$ref": "#/components/schemas/WorkspaceAssigneeSettings"
},
"createdAt": {
"description": "Timestamp of when this workspace was created.",
"format": "date-time",
"type": "string"
},
"defaultPermission": {
"$ref": "#/components/schemas/Permission",
"description": "Default permission for all the team members in this workspace. Note: the final permission can be adjusted corresponding to each user's role, e.g. contributors can't have more than Comment permission."
},
"description": {
"$ref": "#/components/schemas/RichText",
"description": "Description of this workspace."
},
"id": {
"description": "Unique identifier of this workspace.",
"format": "uuid",
"type": "string"
},
"itemColor": {
"$ref": "#/components/schemas/ItemColor",
"description": "Default color applied to newly created items in this workspace. If not defined - a random color will be assigned to each new item."
},
"itemType": {
"$ref": "#/components/schemas/ItemType",
"description": "Type of items in this workspace."
},
"lastActivity": {
"description": "Timestamp of when any entities related to this workspace were last changed.",
"format": "date-time",
"type": "string"
},
"lastUpdatedAt": {
"description": "Timestamp of when this workspace was last updated.",
"format": "date-time",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/WorkspaceWorkspaceMetadata",
"description": "Additional metadata about this workspace."
},
"name": {
"description": "Name of this workspace.",
"type": "string"
},
"namespace": {
"$ref": "#/components/schemas/WorkspaceNamespace",
"description": "The system namespace of this workspace."
},
"order": {
"description": "Order number of this workspace for sorting.",
"format": "int32",
"type": "integer"
},
"progressMode": {
"$ref": "#/components/schemas/WorkspaceProgressMode"
},
"statusPresetId": {
"description": "Optional reference to a shared status preset. When set, statuses are read from the preset instead of workspace-specific statuses.",
"format": "uuid",
"type": "string"
},
"teamId": {
"description": "Id of the team this workspace belongs to.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"teamId",
"name",
"description",
"progressMode",
"createdAt",
"lastUpdatedAt",
"lastActivity",
"namespace",
"order",
"_embedded"
],
"title": "WorkspaceWithWorkspaceSearchEmbed",
"type": "object"
},
"WorkspaceWithWorkspaceSearchEmbedPage": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceSearchEmbed"
},
"type": "array"
},
"totalItems": {
"format": "int32",
"type": "integer"
}
},
"required": [
"items",
"totalItems"
],
"title": "WorkspaceWithWorkspaceSearchEmbedPage",
"type": "object"
},
"WorkspaceWorkspaceMetadata": {
"properties": {
"duplicated": {
"description": "Whether this workspace was duplicated from another workspace.",
"type": "boolean"
},
"templateId": {
"description": "Id of the template used to create this workspace.",
"type": "string"
},
"templateWorkspaceRef": {
"description": "Which specific workspace-instruction in the template was used to create this workspace.",
"type": "string"
},
"version": {
"description": "Version of the server at the moment when this workspace was created.",
"type": "string"
}
},
"required": [
"duplicated"
],
"title": "WorkspaceWorkspaceMetadata",
"type": "object"
},
"ZendeskIntegrationSummary": {
"properties": {
"capabilities": {
"$ref": "#/components/schemas/IntegrationCapabilities"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"format": "uuid",
"type": "string"
},
"lastSyncAt": {
"format": "date-time",
"type": "string"
},
"lastSyncState": {
"$ref": "#/components/schemas/IntegrationSyncState"
},
"settings": {
"$ref": "#/components/schemas/ZendeskIntegrationTypeSettings"
},
"typeId": {
"const": "zendesk",
"type": "string"
}
},
"required": [
"id",
"typeId",
"settings",
"createdAt",
"capabilities",
"enabled"
],
"title": "ZendeskIntegrationSummary",
"type": "object"
},
"ZendeskIntegrationTypeSettings": {
"properties": {
"accessToken": {
"type": "string"
},
"autoSync": {
"type": "boolean"
},
"baseUri": {
"type": "string"
},
"filterTags": {
"default": [],
"items": {
"type": "string"
},
"type": "array"
},
"importFrom": {
"format": "date",
"type": "string"
},
"mappings": {
"default": [],
"items": {
"$ref": "#/components/schemas/MappingSettingsIntegrationMappingSettings"
},
"type": "array"
},
"removeExtraneous": {
"type": "boolean"
},
"title": {
"type": "string"
}
},
"required": [
"importFrom",
"autoSync",
"removeExtraneous"
],
"title": "ZendeskIntegrationTypeSettings",
"type": "object"
}
},
"securitySchemes": {
"httpAuth": {
"scheme": "bearer",
"type": "http"
}
}
},
"info": {
"title": "airfocus API",
"version": "1.0.0-beta.46.222.7"
},
"openapi": "3.1.0",
"paths": {
"/api/ai-actors": {
"get": {
"description": "Requirements:
- auth-client scopes: \"team:read\"",
"operationId": "listAiActors",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AiActor"
},
"type": "array"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "List all AI actors for the caller's team.",
"tags": [
"AI Actors"
]
}
},
"/api/fields": {
"post": {
"description": "Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"full\"
- team features: \"team-fields\" when operating with team-fields
- user role: \"admin\" when operating with team-fields",
"operationId": "installField",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstallFieldRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldWithFieldEmbed"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Install a new field",
"tags": [
"Fields"
]
}
},
"/api/fields/delete": {
"post": {
"description": "Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"full\"
- team features: \"team-fields\" when operating with team-fields
- user role: \"admin\" when operating with team-fields",
"operationId": "bulkDeleteFields",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"204": {
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Delete multiple fields",
"tags": [
"Fields"
]
}
},
"/api/fields/reorder": {
"post": {
"description": "Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"full\"
- team features: \"team-fields\" when operating with team-fields
- user role: \"admin\" when operating with team-fields",
"operationId": "reorderFields",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReorderFieldsRequest"
}
}
},
"required": true
},
"responses": {
"204": {
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Reorder fields",
"tags": [
"Fields"
]
}
},
"/api/fields/search": {
"post": {
"description": "Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher
- team features: \"team-fields\" when operating with team-fields",
"operationId": "searchFields",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldSearchQuery"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldWithFieldEmbedPage"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Search fields",
"tags": [
"Fields"
]
}
},
"/api/fields/types": {
"get": {
"description": "Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher
- team features: \"team-fields\" when operating with team-fields",
"operationId": "listFieldTypes",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/FieldTypeInfo"
},
"type": "array"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "List all available field types",
"tags": [
"Fields"
]
}
},
"/api/fields/workspaces": {
"post": {
"description": "Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"full\"
- team features: \"team-fields\" when operating with team-fields
- user role: \"admin\" when operating with team-fields",
"operationId": "linkTeamFieldsToWorkspaces",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/FieldToWorkspaceLink"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/FieldWithFieldEmbed"
},
"type": "array"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Link team-fields to workspaces",
"tags": [
"Fields"
]
}
},
"/api/fields/workspaces/unlink": {
"post": {
"description": "Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"full\"
- team features: \"team-fields\" when operating with team-fields
- user role: \"admin\" when operating with team-fields",
"operationId": "unlinkTeamFieldsFromWorkspaces",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/FieldToWorkspaceLink"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/FieldWithFieldEmbed"
},
"type": "array"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Unlink team-fields from workspaces",
"tags": [
"Fields"
]
}
},
"/api/fields/{fieldId}": {
"delete": {
"description": "Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"full\"
- team features: \"team-fields\" when operating with team-fields
- user role: \"admin\" when operating with team-fields",
"operationId": "deleteField",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the target field.",
"in": "path",
"name": "fieldId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Delete field",
"tags": [
"Fields"
]
},
"get": {
"description": "Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher
- team features: \"team-fields\" when operating with team-fields",
"operationId": "retrieveField",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the target field.",
"in": "path",
"name": "fieldId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldWithFieldEmbed"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve a single field",
"tags": [
"Fields"
]
},
"put": {
"description": "Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"full\"
- team features: \"team-fields\" when operating with team-fields
- user role: \"admin\" when operating with team-fields",
"operationId": "reconfigureField",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the target field.",
"in": "path",
"name": "fieldId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReconfigureFieldRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldWithFieldEmbed"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Reconfigure field",
"tags": [
"Fields"
]
}
},
"/api/link-types": {
"post": {
"description": "Returns newly created item-link-type with its sanitised data.
Requirements:
- auth-client scopes: \"team\"
- user role: \"admin\"
- user permission: \"write\" or higher",
"operationId": "createItemLinkType",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateItemLinkTypeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemLinkTypeRecordWithItemLinkTypeRecordEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or user does not match the required role, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Create a new item-link-type",
"tags": [
"CRUD",
"Items:Links:Types"
]
}
},
"/api/link-types/bulk": {
"post": {
"description": "Accepts a list of create/update/patch/delete operations (see the request model for more details).
\nEach operation can target a single or multiple item-link-types.
\nReturns a list of results for each input operation including errors.
\nGuarantees that the size and order of the returned results matches the order of input operations.
Note: The following item-link-type IDs are reserved as read-only and will be present on all teams:
- 11111111-1111-1111-1111-111111111111
- 22222222-2222-2222-2222-222222222222
- 33333333-3333-3333-3333-333333333333
Requirements:
- auth-client scopes: \"team\"
- user role: \"admin\"
- user permission: \"write\" or higher",
"operationId": "bulkItemLinkTypes",
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ItemLinkTypeBulkAction"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemLinkTypeRecordWithItemLinkTypeRecordEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or user does not match the required role, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Perform multiple operations with item-link-types",
"tags": [
"CRUD",
"Items:Links:Types"
]
}
},
"/api/link-types/list": {
"post": {
"description": "Returns a list of item-link-types resolved for the provided IDs.
\nGuarantees that the array-size and order of the returned item-link-types matches the order of requested IDs.
\nDoes not fail if any of the requested item-link-types is not found or not accessible - instead it returns null as an array-element of the corresponding item-link-type which could not be accessed.
Requirements:
- auth-client scopes: \"team:read\"
- user permission: \"read\" or higher",
"operationId": "listItemLinkTypes",
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemLinkTypeRecordWithItemLinkTypeRecordEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve multiple item-link-types by their IDs",
"tags": [
"CRUD",
"Items:Links:Types"
]
}
},
"/api/link-types/search": {
"post": {
"description": "Returns all item-link-types or searches item-link-types by query. Always returns only item-link-types which are accessible by the current user.
Requirements:
- auth-client scopes: \"team:read\"
- user permission: \"read\" or higher",
"operationId": "searchItemLinkTypes",
"parameters": [
{
"description": "How many elements to skip.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"description": "How many elements to return.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 1000,
"format": "int32",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "From which element the page should start.",
"in": "query",
"name": "from",
"required": false,
"schema": {
"default": 0,
"deprecated": true,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "At which element the page should end (excluding it).",
"in": "query",
"name": "to",
"required": false,
"schema": {
"deprecated": true,
"format": "int32",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemLinkTypeSearchQuery"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemLinkTypeRecordWithItemLinkTypeRecordEmbedPage"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve or search item-link-types",
"tags": [
"CRUD",
"Items:Links:Types"
]
}
},
"/api/link-types/{itemLinkTypeId}": {
"delete": {
"description": "Returns empty result if the item-link-type was successfully deleted.
Note: Deleting an item-link-type will also delete all item-links of that type.
Note: The following item-link-type IDs are reserved as read-only and will be present on all teams:
- 11111111-1111-1111-1111-111111111111
- 22222222-2222-2222-2222-222222222222
- 33333333-3333-3333-3333-333333333333
Requirements:
- auth-client scopes: \"team\"
- user role: \"admin\"
- user permission: \"write\" or higher",
"operationId": "deleteItemLinkType",
"parameters": [
{
"in": "path",
"name": "itemLinkTypeId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or user does not match the required role, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Delete an existing item-link-type",
"tags": [
"CRUD",
"Items:Links:Types"
]
},
"get": {
"description": "Returns found item-link-type.
Requirements:
- auth-client scopes: \"team:read\"
- user permission: \"read\" or higher",
"operationId": "retrieveItemLinkType",
"parameters": [
{
"in": "path",
"name": "itemLinkTypeId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemLinkTypeRecordWithItemLinkTypeRecordEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve a single item-link-type by its ID",
"tags": [
"CRUD",
"Items:Links:Types"
]
},
"patch": {
"description": "Returns the whole updated item-link-type with its sanitised data.
Note: The following item-link-type IDs are reserved as read-only and will be present on all teams:
- 11111111-1111-1111-1111-111111111111
- 22222222-2222-2222-2222-222222222222
- 33333333-3333-3333-3333-333333333333
Requirements:
- auth-client scopes: \"team\"
- user role: \"admin\"
- user permission: \"write\" or higher",
"operationId": "patchItemLinkType",
"parameters": [
{
"in": "path",
"name": "itemLinkTypeId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonPatch"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemLinkTypeRecordWithItemLinkTypeRecordEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or user does not match the required role, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Patch an existing item-link-type",
"tags": [
"CRUD",
"Items:Links:Types"
]
},
"put": {
"description": "Returns updated item-link-type with its sanitised data.
Note: The following item-link-type IDs are reserved as read-only and will be present on all teams:
- 11111111-1111-1111-1111-111111111111
- 22222222-2222-2222-2222-222222222222
- 33333333-3333-3333-3333-333333333333
Requirements:
- auth-client scopes: \"team\"
- user role: \"admin\"
- user permission: \"write\" or higher",
"operationId": "updateItemLinkType",
"parameters": [
{
"in": "path",
"name": "itemLinkTypeId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemLinkTypeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemLinkTypeRecordWithItemLinkTypeRecordEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or user does not match the required role, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Update an existing item-link-type",
"tags": [
"CRUD",
"Items:Links:Types"
]
}
},
"/api/link-types/{itemLinkTypeId}/workspace-count": {
"get": {
"description": "Requirements:
- auth-client scopes: \"team:read\"
- user role: \"admin\"
- user permission: \"read\" or higher",
"operationId": "retrieveItemLinkTypeWorkspaceCount",
"parameters": [
{
"in": "path",
"name": "itemLinkTypeId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemLinkTypeWorkspaceCount"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or user does not match the required role, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Items:Links:Types"
]
}
},
"/api/profile": {
"get": {
"description": "Requirements:
- auth-client scopes: \"profile:read\"",
"operationId": "retrieveProfile",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Profile"
]
},
"put": {
"description": "Requirements:
- auth-client scopes: \"profile\"",
"operationId": "updateProfile",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateUserRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Profile"
]
}
},
"/api/profile/api-keys": {
"get": {
"description": "Requirements:
- auth-client scopes: \"profile\"
- team features: \"api-keys\"",
"operationId": "listApiKeys",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ApiKey"
},
"type": "array"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required feature"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user's team does not have access to the required features, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Profile"
]
},
"post": {
"description": "Requirements:
- auth-client scopes: \"profile\"
- team features: \"api-keys\"",
"operationId": "createApiKey",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateApiKeyRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateApiKeyResponse"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required feature"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user's team does not have access to the required features, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Profile"
]
}
},
"/api/profile/api-keys/{apiKeyId}": {
"delete": {
"description": "Requirements:
- auth-client scopes: \"profile\"
- team features: \"api-keys\"",
"operationId": "deleteApiKey",
"parameters": [
{
"in": "path",
"name": "apiKeyId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required feature"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user's team does not have access to the required features, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Profile"
]
}
},
"/api/profile/change-password": {
"post": {
"description": "Requirements:
- auth-client scopes: \"profile\"",
"operationId": "changePassword",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangePasswordRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Profile"
]
}
},
"/api/profile/client-settings": {
"get": {
"description": "Requirements:
- auth-client scopes: \"profile:read\"",
"operationId": "getClientSettings",
"parameters": [
{
"in": "query",
"name": "path",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Profile"
]
},
"put": {
"description": "Requirements:
- auth-client scopes: \"profile\"",
"operationId": "setClientSettings",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetClientSettingsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Profile"
]
}
},
"/api/status-presets": {
"post": {
"description": "Returns newly created status-preset with its sanitised data.
Requirements:
- auth-client scopes: \"team\"",
"operationId": "createStatusPreset",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateStatusPresetRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusPresetWithStatusPresetEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Create a new status-preset",
"tags": [
"CRUD",
"StatusPresets"
]
}
},
"/api/status-presets/bulk": {
"post": {
"description": "Accepts a list of create/update/patch/delete operations (see the request model for more details).
\nEach operation can target a single or multiple status-presets.
\nReturns a list of results for each input operation including errors.
\nGuarantees that the size and order of the returned results matches the order of input operations.
Requirements:
- auth-client scopes: \"team\"",
"operationId": "bulkStatusPresets",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/StatusPresetBulkAction"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusPresetWithStatusPresetEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Perform multiple operations with status-presets",
"tags": [
"CRUD",
"StatusPresets"
]
}
},
"/api/status-presets/list": {
"post": {
"description": "Returns a list of status-presets resolved for the provided IDs.
\nGuarantees that the array-size and order of the returned status-presets matches the order of requested IDs.
\nDoes not fail if any of the requested status-presets is not found or not accessible - instead it returns null as an array-element of the corresponding status-preset which could not be accessed.
Requirements:
- auth-client scopes: \"team:read\"",
"operationId": "listStatusPresets",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusPresetWithStatusPresetEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve multiple status-presets by their IDs",
"tags": [
"CRUD",
"StatusPresets"
]
}
},
"/api/status-presets/search": {
"post": {
"description": "Returns all status-presets or searches status-presets by query. Always returns only status-presets which are accessible by the current user.
Requirements:
- auth-client scopes: \"team:read\"",
"operationId": "searchStatusPresets",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "How many elements to skip.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"description": "How many elements to return.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 1000,
"format": "int32",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "From which element the page should start.",
"in": "query",
"name": "from",
"required": false,
"schema": {
"default": 0,
"deprecated": true,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "At which element the page should end (excluding it).",
"in": "query",
"name": "to",
"required": false,
"schema": {
"deprecated": true,
"format": "int32",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusPresetSearchQuery"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusPresetWithStatusPresetEmbedPage"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve or search status-presets",
"tags": [
"CRUD",
"StatusPresets"
]
}
},
"/api/status-presets/workspace/{workspaceId}": {
"post": {
"description": "Creates a new status preset by copying statuses from an existing workspace.
Requirements:
- auth-client scopes: \"team\"",
"operationId": "createStatusPresetFromWorkspace",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateStatusPresetFromWorkspaceRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusPreset"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Create a status preset from a workspace",
"tags": [
"StatusPresets"
]
},
"put": {
"description": "Sets the status preset for the workspace. When switching from one preset to another (or from custom statuses to a preset), replacements must be provided for statuses that have items assigned to them. When unassigning a preset, statuses are duplicated from the preset to the workspace.
Requirements:
- auth-client scopes: \"team\"",
"operationId": "setWorkspaceStatusPreset",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetWorkspaceStatusPresetRequest"
}
}
},
"required": true
},
"responses": {
"204": {
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Assign or unassign a status preset for a workspace.",
"tags": [
"StatusPresets"
]
}
},
"/api/status-presets/{statusPresetId}": {
"delete": {
"description": "Returns empty result if the status-preset was successfully deleted.
Requirements:
- auth-client scopes: \"team\"",
"operationId": "deleteStatusPreset",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "statusPresetId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Delete an existing status-preset",
"tags": [
"CRUD",
"StatusPresets"
]
},
"get": {
"description": "Returns found status-preset.
Requirements:
- auth-client scopes: \"team:read\"",
"operationId": "retrieveStatusPreset",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "statusPresetId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusPresetWithStatusPresetEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve a single status-preset by its ID",
"tags": [
"CRUD",
"StatusPresets"
]
},
"patch": {
"description": "Returns the whole updated status-preset with its sanitised data.
Requirements:
- auth-client scopes: \"team\"",
"operationId": "patchStatusPreset",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "statusPresetId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonPatch"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusPresetWithStatusPresetEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Patch an existing status-preset",
"tags": [
"CRUD",
"StatusPresets"
]
},
"put": {
"description": "Returns updated status-preset with its sanitised data.
Requirements:
- auth-client scopes: \"team\"",
"operationId": "updateStatusPreset",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "statusPresetId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateStatusPresetRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusPresetWithStatusPresetEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Update an existing status-preset",
"tags": [
"CRUD",
"StatusPresets"
]
}
},
"/api/status-presets/{statusPresetId}/statuses": {
"put": {
"description": "Updates the statuses linked to a status preset. Replacements must be specified for each status being removed, so that items in workspaces using this preset can be migrated to new statuses.
Requirements:
- auth-client scopes: \"team\"",
"operationId": "updateStatusPresetStatuses",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "statusPresetId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateStatusPresetStatusesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusPresetWithStatusPresetEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Update statuses of a status preset",
"tags": [
"StatusPresets"
]
}
},
"/api/team": {
"get": {
"description": "Requirements:
- auth-client scopes: \"team:read\"",
"operationId": "retrieveTeam",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Team"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Team"
]
}
},
"/api/team/flags": {
"patch": {
"description": "Requirements:
- auth-client scopes: \"team\"
- user role: \"admin\"",
"operationId": "updateTeamFlags",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTeamFlagsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamFlags"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient role"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not match the required role, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Team"
]
}
},
"/api/team/maintenance-window": {
"get": {
"description": "Requirements:
- auth-client scopes: \"team:read\"",
"operationId": "getMaintenanceWindow",
"parameters": [
{
"in": "query",
"name": "upcomingDays",
"required": false,
"schema": {
"format": "int32",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/TeamMaintenanceWindow"
},
"type": "array"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Team"
]
}
},
"/api/team/tos": {
"post": {
"description": "Requirements:
- auth-client scopes: \"team\"
- user role: \"admin\"",
"operationId": "acceptTermsOfService",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreAcceptedTosRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient role"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not match the required role, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Team"
]
}
},
"/api/team/users": {
"get": {
"description": "List team users.
Requirements:
- auth-client scopes: \"team:read\"",
"operationId": "listUsers",
"parameters": [
{
"in": "query",
"name": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/User"
},
"type": "array"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Team"
]
}
},
"/api/team/users/disabled": {
"post": {
"description": "Requirements:
- auth-client scopes: \"team\"
- user role: \"admin\"",
"operationId": "changeUserDisabled",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeUserDisabledRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient role"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not match the required role, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Team"
]
}
},
"/api/team/users/invite": {
"post": {
"description": "Requirements:
- auth-client scopes: \"team\"
- user role: \"admin\"",
"operationId": "sendUserInvite",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InviteUserRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient role"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not match the required role, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Team"
]
}
},
"/api/team/users/invite/bulk": {
"post": {
"description": "Requirements:
- auth-client scopes: \"team\"
- user role: \"admin\"",
"operationId": "sendBulkUserInvites",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkInviteUsersRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/User"
},
"type": "array"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient role"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not match the required role, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Team"
]
}
},
"/api/team/users/invite/create": {
"post": {
"description": "Requirements:
- auth-client scopes: \"team\"
- user role: \"admin\"",
"operationId": "createUserInvite",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateUserInviteRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient role"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not match the required role, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Team"
]
}
},
"/api/team/users/invite/resend": {
"post": {
"description": "Requirements:
- auth-client scopes: \"team\"
- user role: \"admin\"",
"operationId": "resendUserInvite",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResendUserInviteRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient role"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not match the required role, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Team"
]
}
},
"/api/team/users/kick": {
"post": {
"description": "Requirements:
- auth-client scopes: \"team\"
- user role: \"admin\"",
"operationId": "kickUser",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KickUserRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient role"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not match the required role, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Team"
]
}
},
"/api/team/users/role": {
"post": {
"description": "Requirements:
- auth-client scopes: \"team\"
- user role: \"admin\"",
"operationId": "changeUserRole",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeUserRoleRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient role"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not match the required role, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Team"
]
}
},
"/api/templates": {
"get": {
"description": "Returns all workspace-templates available to the current team.
Requirements:
- auth-client scopes: \"workspace:read\"",
"operationId": "listTemplates",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "How many elements to skip.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"description": "How many elements to return.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 100,
"format": "int32",
"maximum": 100,
"minimum": 0,
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplatePageWithEmbed"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "List templates",
"tags": [
"Templates"
]
}
},
"/api/templates/apply/{templateId}": {
"post": {
"description": "Installs the requested template with the given parameters.\nReturns a newly created workspace.\nIf the template creates multiple workspaces - then it still returns a single workspace which is considered by the template as \"main\".
Requirements:
- auth-client scopes: \"workspace\"",
"operationId": "applyTemplate",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "templateId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplyTemplateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbed"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Install template",
"tags": [
"Templates"
]
}
},
"/api/templates/export": {
"post": {
"description": "Returns an object containing instructions, required for installing such a template.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "exportTemplateInstructions",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportTemplateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateInstructions"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Exports a template for given workspaces.",
"tags": [
"Templates"
]
}
},
"/api/workspaces": {
"post": {
"description": "Returns newly created workspace with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "createWorkspace",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWorkspaceRequest"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/CreateWorkspaceRequestWithMD"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/CreateWorkspaceRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbed"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithMDWithWorkspaceEmbed"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Create a new workspace",
"tags": [
"CRUD",
"Workspaces"
]
}
},
"/api/workspaces/alias/{aliasValue}": {
"get": {
"description": "Returns found workspace.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "retrieveWorkspaceByAlias",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"example": "DEV",
"in": "path",
"name": "aliasValue",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbed"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithMDWithWorkspaceEmbed"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve a single workspace by its alias (e.g. 'DEV').",
"tags": [
"Workspaces"
]
}
},
"/api/workspaces/bulk": {
"post": {
"description": "Accepts a list of create/update/patch/delete operations (see the request model for more details).
\nEach operation can target a single or multiple workspaces.
\nReturns a list of results for each input operation including errors.
\nGuarantees that the size and order of the returned results matches the order of input operations.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "bulkWorkspaces",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/WorkspaceBulkAction"
},
"type": "array"
}
},
"application/json+markdown": {
"schema": {
"items": {
"$ref": "#/components/schemas/WorkspaceBulkAction"
},
"type": "array"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"items": {
"$ref": "#/components/schemas/WorkspaceBulkAction"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbedOrNullList"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithMDWithWorkspaceEmbedOrNullList"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Perform multiple operations with workspaces",
"tags": [
"CRUD",
"Workspaces"
]
}
},
"/api/workspaces/count": {
"get": {
"description": "Returns the total counter number.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "countWorkspaces",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"format": "int32",
"type": "integer"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Count workspaces in the current team.",
"tags": [
"Workspaces"
]
}
},
"/api/workspaces/extensions/views/inbox/{viewId}/counters": {
"post": {
"description": "Requirements:
- auth-client scopes: \"workspace:read\"
- team features: \"view:inbox\"
- user permission: \"read\" or higher",
"operationId": "retrieveInboxViewCounters",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "viewId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InboxViewCountersRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/InboxViewCounter"
},
"type": "array"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or user's team does not have access to the required features, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve counters of items in each tab of the view."
}
},
"/api/workspaces/global-search": {
"post": {
"description": "Requirements:
- auth-client scopes: \"workspace:read\"",
"operationId": "searchGlobal",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "How many elements to skip.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"description": "How many elements to return.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 25,
"format": "int32",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "From which element the page should start.",
"in": "query",
"name": "from",
"required": false,
"schema": {
"default": 0,
"deprecated": true,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "At which element the page should end (excluding it).",
"in": "query",
"name": "to",
"required": false,
"schema": {
"deprecated": true,
"format": "int32",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalSearchQuery"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalSearchResultPage"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"tags": [
"Global search"
]
}
},
"/api/workspaces/groups": {
"post": {
"description": "Returns newly created workspace group with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "createWorkspaceGroup",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceGroupParams"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceGroupWithWorkspaceGroupEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Create a new workspace group",
"tags": [
"CRUD",
"WorkspaceGroups"
]
}
},
"/api/workspaces/groups/assign": {
"post": {
"description": "Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "assignWorkspaceToGroup",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceGroupAssignWorkspaceRequest"
}
}
},
"required": true
},
"responses": {
"204": {
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Assign workspace to group.",
"tags": [
"WorkspaceGroups"
]
}
},
"/api/workspaces/groups/bulk": {
"post": {
"description": "Accepts a list of create/update/patch/delete operations (see the request model for more details).
\nEach operation can target a single or multiple workspace groups.
\nReturns a list of results for each input operation including errors.
\nGuarantees that the size and order of the returned results matches the order of input operations.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "bulkWorkspaceGroups",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/WorkspaceGroupBulkAction"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceGroupWithWorkspaceGroupEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Perform multiple operations with workspace groups",
"tags": [
"CRUD",
"WorkspaceGroups"
]
}
},
"/api/workspaces/groups/list": {
"post": {
"description": "Returns a list of workspace groups resolved for the provided IDs.
\nGuarantees that the array-size and order of the returned workspace groups matches the order of requested IDs.
\nDoes not fail if any of the requested workspace groups is not found or not accessible - instead it returns null as an array-element of the corresponding workspace group which could not be accessed.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "listWorkspaceGroups",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceGroupWithWorkspaceGroupEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve multiple workspace groups by their IDs",
"tags": [
"CRUD",
"WorkspaceGroups"
]
}
},
"/api/workspaces/groups/search": {
"post": {
"description": "Returns all workspace groups or searches workspace groups by query. Always returns only workspace groups which are accessible by the current user.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "searchWorkspaceGroups",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "How many elements to skip.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"description": "How many elements to return.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 1000,
"format": "int32",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "From which element the page should start.",
"in": "query",
"name": "from",
"required": false,
"schema": {
"default": 0,
"deprecated": true,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "At which element the page should end (excluding it).",
"in": "query",
"name": "to",
"required": false,
"schema": {
"deprecated": true,
"format": "int32",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceGroupSearchQuery"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceGroupWithWorkspaceGroupSearchEmbedPage"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve or search workspace groups",
"tags": [
"CRUD",
"WorkspaceGroups"
]
}
},
"/api/workspaces/groups/{workspaceGroupId}": {
"delete": {
"description": "Returns empty result if the workspace group was successfully deleted.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "deleteWorkspaceGroup",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceGroupId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Delete an existing workspace group",
"tags": [
"CRUD",
"WorkspaceGroups"
]
},
"get": {
"description": "Returns found workspace group.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "retrieveWorkspaceGroup",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceGroupId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceGroupWithWorkspaceGroupEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve a single workspace group by its ID",
"tags": [
"CRUD",
"WorkspaceGroups"
]
},
"patch": {
"description": "Returns the whole updated workspace group with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "patchWorkspaceGroup",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceGroupId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonPatch"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceGroupWithWorkspaceGroupEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Patch an existing workspace group",
"tags": [
"CRUD",
"WorkspaceGroups"
]
},
"put": {
"description": "Returns updated workspace group with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "updateWorkspaceGroup",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceGroupId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceGroupParams"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceGroupWithWorkspaceGroupEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Update an existing workspace group",
"tags": [
"CRUD",
"WorkspaceGroups"
]
}
},
"/api/workspaces/groups/{workspaceGroupId}/permissions": {
"post": {
"description": "Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "updateWorkspaceGroupPermissions",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceGroupId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceGroupPermissionsUpdateRequest"
}
}
},
"required": true
},
"responses": {
"204": {
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Update workspace-group permissions.",
"tags": [
"WorkspaceGroups"
]
}
},
"/api/workspaces/item-relations": {
"post": {
"description": "Returns newly created item-relation with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "createItemRelation",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemRelationCreateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemRelationWithItemRelationEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Create a new item-relation",
"tags": [
"CRUD",
"Items:Relations"
]
}
},
"/api/workspaces/item-relations/bulk": {
"post": {
"description": "Accepts a list of create/update/patch/delete operations (see the request model for more details).
\nEach operation can target a single or multiple item-relations.
\nReturns a list of results for each input operation including errors.
\nGuarantees that the size and order of the returned results matches the order of input operations.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "bulkItemRelations",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ItemRelationBulkAction"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemRelationWithItemRelationEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Perform multiple operations with item-relations",
"tags": [
"CRUD",
"Items:Relations"
]
}
},
"/api/workspaces/item-relations/list": {
"post": {
"description": "Returns a list of item-relations resolved for the provided IDs.
\nGuarantees that the array-size and order of the returned item-relations matches the order of requested IDs.
\nDoes not fail if any of the requested item-relations is not found or not accessible - instead it returns null as an array-element of the corresponding item-relation which could not be accessed.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "listItemRelations",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemRelationWithItemRelationEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve multiple item-relations by their IDs",
"tags": [
"CRUD",
"Items:Relations"
]
}
},
"/api/workspaces/item-relations/search": {
"post": {
"description": "Returns all item-relations or searches item-relations by query. Always returns only item-relations which are accessible by the current user.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "searchItemRelations",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "How many elements to skip.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"description": "How many elements to return.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 1000,
"format": "int32",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "From which element the page should start.",
"in": "query",
"name": "from",
"required": false,
"schema": {
"default": 0,
"deprecated": true,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "At which element the page should end (excluding it).",
"in": "query",
"name": "to",
"required": false,
"schema": {
"deprecated": true,
"format": "int32",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemRelationSearchQuery"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemRelationWithItemRelationEmbedPage"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve or search item-relations",
"tags": [
"CRUD",
"Items:Relations"
]
}
},
"/api/workspaces/item-relations/{itemRelationId}": {
"delete": {
"description": "Returns empty result if the item-relation was successfully deleted.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "deleteItemRelation",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "itemRelationId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Delete an existing item-relation",
"tags": [
"CRUD",
"Items:Relations"
]
},
"get": {
"description": "Returns found item-relation.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "retrieveItemRelation",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "itemRelationId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemRelationWithItemRelationEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve a single item-relation by its ID",
"tags": [
"CRUD",
"Items:Relations"
]
},
"patch": {
"description": "Returns the whole updated item-relation with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "patchItemRelation",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "itemRelationId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonPatch"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemRelationWithItemRelationEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Patch an existing item-relation",
"tags": [
"CRUD",
"Items:Relations"
]
},
"put": {
"description": "Returns updated item-relation with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "updateItemRelation",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "itemRelationId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemRelationUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemRelationWithItemRelationEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Update an existing item-relation",
"tags": [
"CRUD",
"Items:Relations"
]
}
},
"/api/workspaces/items/alias/{aliasValue}": {
"get": {
"description": "Returns found item.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "retrieveItemByAlias",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"example": "DEV-123",
"in": "path",
"name": "aliasValue",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbed"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemWithMDWithItemEmbed"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve a single item by its alias (e.g. 'DEV-123').",
"tags": [
"Items"
]
}
},
"/api/workspaces/items/copy": {
"post": {
"description": "Returns ids of newly copied items, with order of the returned ids matching the order of requested source items. Returns Not Found if either of the specified source items does not exist.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "copyItems",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Workspace of the source items to be copied.",
"in": "query",
"name": "sourceWorkspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "Target workspace for the newly copied items.",
"in": "query",
"name": "targetWorkspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
}
},
"description": "List of item IDs to be copied.",
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
}
},
"description": "List of newly created item IDs."
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid or one of the specified source items or the target workspace does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Copy specified items.",
"tags": [
"Items"
]
}
},
"/api/workspaces/items/list": {
"post": {
"description": "Returns an array of results, where each element is either a found item with its embeddings, or null if there no item with such ID.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "listItemsGlobal",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
}
},
"description": "List of item IDs to be retrieve from any workspace in the team.",
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbedOrNullList"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemWithMDWithItemEmbedOrNullList"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve items from any workspace by specified IDs.",
"tags": [
"Items"
]
}
},
"/api/workspaces/items/move": {
"post": {
"description": "Returns ids of newly created items in the target workspace, with order of the returned ids matching the order of requested source items. Returns Not Found if either of the specified source items does not exist.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "moveItems",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Workspace of the source items to be moved.",
"in": "query",
"name": "sourceWorkspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "New target workspace for the moved items.",
"in": "query",
"name": "targetWorkspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
}
},
"description": "List of item IDs to be moved.",
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
}
},
"description": "List of newly created item IDs."
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid or one of the specified source items or the target workspace does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Move specified items from one workspace to another.",
"tags": [
"Items"
]
}
},
"/api/workspaces/list": {
"post": {
"description": "Returns a list of workspaces resolved for the provided IDs.
\nGuarantees that the array-size and order of the returned workspaces matches the order of requested IDs.
\nDoes not fail if any of the requested workspaces is not found or not accessible - instead it returns null as an array-element of the corresponding workspace which could not be accessed.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "listWorkspaces",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbedOrNullList"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithMDWithWorkspaceEmbedOrNullList"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve multiple workspaces by their IDs",
"tags": [
"CRUD",
"Workspaces"
]
}
},
"/api/workspaces/notifications/settings": {
"get": {
"description": "Requirements:
- auth-client scopes: \"profile:read\"",
"operationId": "getNotificationSettings",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationSettings"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Get notification settings of a user.",
"tags": [
"Notification Settings"
]
},
"post": {
"description": "Requirements:
- auth-client scopes: \"profile\"",
"operationId": "updateNotificationSettings",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationSettingUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationSettings"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Update notification settings of a user.",
"tags": [
"Notification Settings"
]
}
},
"/api/workspaces/search": {
"post": {
"description": "Returns all workspaces or searches workspaces by query. Always returns only workspaces which are accessible by the current user.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "searchWorkspaces",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "How many elements to skip.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"description": "How many elements to return.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 1000,
"format": "int32",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "From which element the page should start.",
"in": "query",
"name": "from",
"required": false,
"schema": {
"default": 0,
"deprecated": true,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "At which element the page should end (excluding it).",
"in": "query",
"name": "to",
"required": false,
"schema": {
"deprecated": true,
"format": "int32",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceSearchQuery"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceSearchEmbedPage"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithMDWithWorkspaceSearchEmbedPage"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceSearchEmbedPage"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve or search workspaces",
"tags": [
"CRUD",
"Workspaces"
]
}
},
"/api/workspaces/templates": {
"get": {
"deprecated": true,
"description": "Returns all workspace-templates available to the current team.
Requirements:
- auth-client scopes: \"workspace:read\"",
"operationId": "listTemplatesLegacy",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "How many elements to skip.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"description": "How many elements to return.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 100,
"format": "int32",
"maximum": 100,
"minimum": 0,
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplatePageWithEmbed"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "List templates",
"tags": [
"Templates"
]
}
},
"/api/workspaces/templates/{templateId}": {
"post": {
"deprecated": true,
"description": "Installs the requested template with the given parameters.\nReturns a newly created workspace.\nIf the template creates multiple workspaces - then it still returns a single workspace which is considered by the template as \"main\".
Requirements:
- auth-client scopes: \"workspace\"",
"operationId": "applyTemplateLegacy",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "templateId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplyTemplateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbed"
}
}
},
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Missing required access scope"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Install template",
"tags": [
"Templates"
]
}
},
"/api/workspaces/{workspaceId}": {
"delete": {
"description": "Returns empty result if the workspace was successfully deleted.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "deleteWorkspace",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Delete an existing workspace",
"tags": [
"CRUD",
"Workspaces"
]
},
"get": {
"description": "Returns found workspace.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "retrieveWorkspace",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbed"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithMDWithWorkspaceEmbed"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve a single workspace by its ID",
"tags": [
"CRUD",
"Workspaces"
]
},
"patch": {
"description": "Returns the whole updated workspace with its sanitised data.
Note: also supports patching description as a Markdown string.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "patchWorkspace",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonPatch"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbed"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithMDWithWorkspaceEmbed"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Patch an existing workspace",
"tags": [
"CRUD",
"Workspaces"
]
},
"put": {
"description": "Returns updated workspace with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "updateWorkspace",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateWorkspaceRequest"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/UpdateWorkspaceRequestWithMD"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/UpdateWorkspaceRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbed"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithMDWithWorkspaceEmbed"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Update an existing workspace",
"tags": [
"CRUD",
"Workspaces"
]
}
},
"/api/workspaces/{workspaceId}/attachments": {
"post": {
"description": "Returns newly created attachment with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "createItemAttachment",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateItemAttachmentRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemAttachmentWithEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Create a new attachment",
"tags": [
"CRUD",
"ItemAttachments"
]
}
},
"/api/workspaces/{workspaceId}/attachments/bulk": {
"post": {
"description": "Accepts a list of create/update/patch/delete operations (see the request model for more details).
\nEach operation can target a single or multiple attachments.
\nReturns a list of results for each input operation including errors.
\nGuarantees that the size and order of the returned results matches the order of input operations.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "bulkItemAttachments",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ItemAttachmentBulkAction"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemAttachmentWithEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Perform multiple operations with attachments",
"tags": [
"CRUD",
"ItemAttachments"
]
}
},
"/api/workspaces/{workspaceId}/attachments/list": {
"post": {
"description": "Returns a list of attachments resolved for the provided IDs.
\nGuarantees that the array-size and order of the returned attachments matches the order of requested IDs.
\nDoes not fail if any of the requested attachments is not found or not accessible - instead it returns null as an array-element of the corresponding attachment which could not be accessed.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "listItemAttachments",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemAttachmentWithEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve multiple attachments by their IDs",
"tags": [
"CRUD",
"ItemAttachments"
]
}
},
"/api/workspaces/{workspaceId}/attachments/search": {
"post": {
"description": "Returns all attachments or searches attachments by query. Always returns only attachments which are accessible by the current user.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "searchItemAttachments",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "How many elements to skip.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"description": "How many elements to return.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 1000,
"format": "int32",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "From which element the page should start.",
"in": "query",
"name": "from",
"required": false,
"schema": {
"default": 0,
"deprecated": true,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "At which element the page should end (excluding it).",
"in": "query",
"name": "to",
"required": false,
"schema": {
"deprecated": true,
"format": "int32",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentSearchQuery"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemAttachmentWithEmbedPage"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve or search attachments",
"tags": [
"CRUD",
"ItemAttachments"
]
}
},
"/api/workspaces/{workspaceId}/attachments/{itemAttachmentId}": {
"delete": {
"description": "Returns empty result if the attachment was successfully deleted.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "deleteItemAttachment",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "itemAttachmentId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Delete an existing attachment",
"tags": [
"CRUD",
"ItemAttachments"
]
},
"get": {
"description": "Returns found attachment.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "retrieveItemAttachment",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "itemAttachmentId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemAttachmentWithEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve a single attachment by its ID",
"tags": [
"CRUD",
"ItemAttachments"
]
},
"patch": {
"description": "Returns the whole updated attachment with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "patchItemAttachment",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "itemAttachmentId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonPatch"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemAttachmentWithEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Patch an existing attachment",
"tags": [
"CRUD",
"ItemAttachments"
]
},
"put": {
"description": "Returns updated attachment with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "updateItemAttachment",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "itemAttachmentId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemAttachmentRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemAttachmentWithEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Update an existing attachment",
"tags": [
"CRUD",
"ItemAttachments"
]
}
},
"/api/workspaces/{workspaceId}/comments": {
"post": {
"description": "Returns newly created comment with its sanitised data.
Requirements:
- auth-client scopes: \"workspace:comment\"
- user permission: \"comment\" or higher",
"operationId": "createComment",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentCreateRequest"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemCommentCreateRequest"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentCreateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbed"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbed"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Create a new comment",
"tags": [
"CRUD",
"Comments"
]
}
},
"/api/workspaces/{workspaceId}/comments/bulk": {
"post": {
"description": "Accepts a list of create/update/patch/delete operations (see the request model for more details).
\nEach operation can target a single or multiple comments.
\nReturns a list of results for each input operation including errors.
\nGuarantees that the size and order of the returned results matches the order of input operations.
Requirements:
- auth-client scopes: \"workspace:comment\"
- user permission: \"comment\" or higher",
"operationId": "bulkComments",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/CommentBulkAction"
},
"type": "array"
}
},
"application/json+markdown": {
"schema": {
"items": {
"$ref": "#/components/schemas/CommentBulkAction"
},
"type": "array"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"items": {
"$ref": "#/components/schemas/CommentBulkAction"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbedOrNullList"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbedOrNullList"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Perform multiple operations with comments",
"tags": [
"CRUD",
"Comments"
]
}
},
"/api/workspaces/{workspaceId}/comments/list": {
"post": {
"description": "Returns a list of comments resolved for the provided IDs.
\nGuarantees that the array-size and order of the returned comments matches the order of requested IDs.
\nDoes not fail if any of the requested comments is not found or not accessible - instead it returns null as an array-element of the corresponding comment which could not be accessed.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "listComments",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbedOrNullList"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbedOrNullList"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve multiple comments by their IDs",
"tags": [
"CRUD",
"Comments"
]
}
},
"/api/workspaces/{workspaceId}/comments/search": {
"post": {
"description": "Returns all comments or searches comments by query. Always returns only comments which are accessible by the current user.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "searchComments",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "How many elements to skip.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"description": "How many elements to return.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 1000,
"format": "int32",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "From which element the page should start.",
"in": "query",
"name": "from",
"required": false,
"schema": {
"default": 0,
"deprecated": true,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "At which element the page should end (excluding it).",
"in": "query",
"name": "to",
"required": false,
"schema": {
"deprecated": true,
"format": "int32",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentSearchQuery"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbedPage"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbedPage"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbedPage"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve or search comments",
"tags": [
"CRUD",
"Comments"
]
}
},
"/api/workspaces/{workspaceId}/comments/{commentId}": {
"delete": {
"description": "Returns empty result if the comment was successfully deleted.
Requirements:
- auth-client scopes: \"workspace:comment\"
- user permission: \"comment\" or higher",
"operationId": "deleteComment",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "commentId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Delete an existing comment",
"tags": [
"CRUD",
"Comments"
]
},
"get": {
"description": "Returns found comment.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "retrieveComment",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "commentId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbed"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbed"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve a single comment by its ID",
"tags": [
"CRUD",
"Comments"
]
},
"patch": {
"description": "Returns the whole updated comment with its sanitised data.
Requirements:
- auth-client scopes: \"workspace:comment\"
- user permission: \"comment\" or higher",
"operationId": "patchComment",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "commentId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonPatch"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbed"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbed"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Patch an existing comment",
"tags": [
"CRUD",
"Comments"
]
},
"put": {
"description": "Returns updated comment with its sanitised data.
Requirements:
- auth-client scopes: \"workspace:comment\"
- user permission: \"comment\" or higher",
"operationId": "updateComment",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "commentId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentUpdateRequest"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemCommentUpdateRequest"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbed"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbed"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemCommentWithItemCommentEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Update an existing comment",
"tags": [
"CRUD",
"Comments"
]
}
},
"/api/workspaces/{workspaceId}/comments/{commentId}/reactions/{emojiCode}": {
"delete": {
"description": "Requirements:
- auth-client scopes: \"workspace:comment\"
- user permission: \"comment\" or higher",
"operationId": "removeCommentReaction",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "commentId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "emojiCode",
"required": true,
"schema": {
"$ref": "#/components/schemas/Emoji"
}
}
],
"responses": {
"204": {
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Remove a reaction from the specified comment.",
"tags": [
"Comments"
]
},
"post": {
"description": "Requirements:
- auth-client scopes: \"workspace:comment\"
- user permission: \"comment\" or higher",
"operationId": "addCommentReaction",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "commentId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "emojiCode",
"required": true,
"schema": {
"$ref": "#/components/schemas/Emoji"
}
}
],
"responses": {
"204": {
"description": ""
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Add a reaction to the specified comment.",
"tags": [
"Comments"
]
}
},
"/api/workspaces/{workspaceId}/duplicate": {
"post": {
"description": "Returns the newly created workspace with embedded data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "duplicateWorkspace",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceDuplicateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceWithWorkspaceEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Duplicate workspace with all its items and apps.",
"tags": [
"Workspaces"
]
}
},
"/api/workspaces/{workspaceId}/items": {
"post": {
"description": "Returns newly created item with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "createItem",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed items.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateItemRequest"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/CreateItemRequestWithMD"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/CreateItemRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbed"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemWithMDWithItemEmbed"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Create a new item",
"tags": [
"CRUD",
"Items"
]
}
},
"/api/workspaces/{workspaceId}/items/analytics": {
"post": {
"description": "Returns items in the requested shape. The responses has 1-1 mapping with requests for batching purposes.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "getItemsAnalytics",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed items.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/GetItemsAnalyticsRequest"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/GetItemsAnalyticsResponse"
},
"type": "array"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve items used for dashboards and analytics",
"tags": [
"Items"
]
}
},
"/api/workspaces/{workspaceId}/items/bulk": {
"post": {
"description": "Accepts a list of create/update/patch/delete operations (see the request model for more details).
\nEach operation can target a single or multiple items.
\nReturns a list of results for each input operation including errors.
\nGuarantees that the size and order of the returned results matches the order of input operations.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "bulkItems",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed items.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ItemBulkAction"
},
"type": "array"
}
},
"application/json+markdown": {
"schema": {
"items": {
"$ref": "#/components/schemas/ItemBulkAction"
},
"type": "array"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ItemBulkAction"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbedOrNullList"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemWithMDWithItemEmbedOrNullList"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Perform multiple operations with items",
"tags": [
"CRUD",
"Items"
]
}
},
"/api/workspaces/{workspaceId}/items/list": {
"post": {
"description": "Returns a list of items resolved for the provided IDs.
\nGuarantees that the array-size and order of the returned items matches the order of requested IDs.
\nDoes not fail if any of the requested items is not found or not accessible - instead it returns null as an array-element of the corresponding item which could not be accessed.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "listItems",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed items.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbedOrNullList"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemWithMDWithItemEmbedOrNullList"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve multiple items by their IDs",
"tags": [
"CRUD",
"Items"
]
}
},
"/api/workspaces/{workspaceId}/items/reset-colors": {
"post": {
"description": "Sets all items to match the color configured in the workspace settings if it's configured, otherwise resets each item with a randomly generated color from the available color palette.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "resetItemColors",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed items.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If target workspace does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Reset colors of all items in the specified workspace.",
"tags": [
"Items"
]
}
},
"/api/workspaces/{workspaceId}/items/search": {
"post": {
"description": "Returns all items or searches items by query. Always returns only items which are accessible by the current user.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "searchItems",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed items.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "How many elements to skip.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"description": "How many elements to return.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 1000,
"format": "int32",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "From which element the page should start.",
"in": "query",
"name": "from",
"required": false,
"schema": {
"default": 0,
"deprecated": true,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "At which element the page should end (excluding it).",
"in": "query",
"name": "to",
"required": false,
"schema": {
"deprecated": true,
"format": "int32",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemSearchQuery"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbedPage"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemWithMDWithItemEmbedPage"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbedPage"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve or search items",
"tags": [
"CRUD",
"Items"
]
}
},
"/api/workspaces/{workspaceId}/items/search/partial": {
"post": {
"description": "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",
"operationId": "searchPartialItems",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed items.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "How many elements to skip.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"description": "How many elements to return.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 1000,
"format": "int32",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "From which element the page should start.",
"in": "query",
"name": "from",
"required": false,
"schema": {
"default": 0,
"deprecated": true,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "At which element the page should end (excluding it).",
"in": "query",
"name": "to",
"required": false,
"schema": {
"deprecated": true,
"format": "int32",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchPartialItemRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemPartialWithItemPartialEmbedPage"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve or search partial items",
"tags": [
"Items"
]
}
},
"/api/workspaces/{workspaceId}/items/unwatch": {
"post": {
"description": "Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "unwatchItems",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed items.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
}
},
"description": "List of item IDs to unwatch.",
"required": false
},
"responses": {
"204": {
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Remove watching status of the current user for the specified items.",
"tags": [
"Items"
]
}
},
"/api/workspaces/{workspaceId}/items/watch": {
"post": {
"description": "Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "watchItems",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed items.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
}
},
"description": "List of item IDs to watch.",
"required": false
},
"responses": {
"204": {
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Set current user as a watcher of the specified items.",
"tags": [
"Items"
]
}
},
"/api/workspaces/{workspaceId}/items/{itemId}": {
"delete": {
"description": "Returns empty result if the item was successfully deleted.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "deleteItem",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed items.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "itemId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Delete an existing item",
"tags": [
"CRUD",
"Items"
]
},
"get": {
"description": "Returns found item.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "retrieveItem",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed items.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "itemId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbed"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemWithMDWithItemEmbed"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve a single item by its ID",
"tags": [
"CRUD",
"Items"
]
},
"patch": {
"description": "Returns the whole updated item with its sanitised data.
Note: also supports patching description as a Markdown string.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "patchItem",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed items.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "itemId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonPatch"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbed"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemWithMDWithItemEmbed"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Patch an existing item",
"tags": [
"CRUD",
"Items"
]
},
"put": {
"description": "Returns updated item with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "updateItem",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed items.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "itemId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemRequest"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/UpdateItemRequestWithMD"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbed"
}
},
"application/json+markdown": {
"schema": {
"$ref": "#/components/schemas/ItemWithMDWithItemEmbed"
}
},
"application/vnd.airfocus.markdown+json": {
"schema": {
"$ref": "#/components/schemas/ItemWithItemEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Update an existing item",
"tags": [
"CRUD",
"Items"
]
}
},
"/api/workspaces/{workspaceId}/links": {
"post": {
"description": "Returns newly created item-link with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "createItemLink",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed item-links.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateItemLinkRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemLinkWithItemLinkEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Create a new item-link",
"tags": [
"CRUD",
"Items:Links"
]
}
},
"/api/workspaces/{workspaceId}/links/bulk": {
"post": {
"description": "Accepts a list of create/update/patch/delete operations (see the request model for more details).
\nEach operation can target a single or multiple item-links.
\nReturns a list of results for each input operation including errors.
\nGuarantees that the size and order of the returned results matches the order of input operations.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "bulkItemLinks",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed item-links.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ItemLinkBulkAction"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemLinkWithItemLinkEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Perform multiple operations with item-links",
"tags": [
"CRUD",
"Items:Links"
]
}
},
"/api/workspaces/{workspaceId}/links/list": {
"post": {
"description": "Returns a list of item-links resolved for the provided IDs.
\nGuarantees that the array-size and order of the returned item-links matches the order of requested IDs.
\nDoes not fail if any of the requested item-links is not found or not accessible - instead it returns null as an array-element of the corresponding item-link which could not be accessed.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "listItemLinks",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed item-links.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemLinkWithItemLinkEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve multiple item-links by their IDs",
"tags": [
"CRUD",
"Items:Links"
]
}
},
"/api/workspaces/{workspaceId}/links/search": {
"post": {
"description": "Returns all item-links or searches item-links by query. Always returns only item-links which are accessible by the current user.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "searchItemLinks",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed item-links.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "How many elements to skip.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"description": "How many elements to return.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 1000,
"format": "int32",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "From which element the page should start.",
"in": "query",
"name": "from",
"required": false,
"schema": {
"default": 0,
"deprecated": true,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "At which element the page should end (excluding it).",
"in": "query",
"name": "to",
"required": false,
"schema": {
"deprecated": true,
"format": "int32",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemLinkSearchQuery"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemLinkWithItemLinkEmbedPage"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve or search item-links",
"tags": [
"CRUD",
"Items:Links"
]
}
},
"/api/workspaces/{workspaceId}/links/{itemLinkId}": {
"delete": {
"description": "Returns empty result if the item-link was successfully deleted.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "deleteItemLink",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed item-links.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "itemLinkId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Delete an existing item-link",
"tags": [
"CRUD",
"Items:Links"
]
},
"get": {
"description": "Returns found item-link.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "retrieveItemLink",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed item-links.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "itemLinkId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemLinkWithItemLinkEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Retrieve a single item-link by its ID",
"tags": [
"CRUD",
"Items:Links"
]
},
"patch": {
"description": "Returns the whole updated item-link with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "patchItemLink",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed item-links.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "itemLinkId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonPatch"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemLinkWithItemLinkEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Patch an existing item-link",
"tags": [
"CRUD",
"Items:Links"
]
},
"put": {
"description": "Returns updated item-link with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "updateItemLink",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed item-links.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "itemLinkId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateItemLinkRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemLinkWithItemLinkEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Update an existing item-link",
"tags": [
"CRUD",
"Items:Links"
]
}
},
"/api/workspaces/{workspaceId}/milestones": {
"post": {
"deprecated": true,
"description": "Returns newly created milestone with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "createMilestone",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed milestones.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateMilestoneRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MilestoneWithEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "[DEPRECATED: use custom fields of type 'milestone'] Create a new milestone",
"tags": [
"CRUD",
"Milestones"
]
}
},
"/api/workspaces/{workspaceId}/milestones/bulk": {
"post": {
"deprecated": true,
"description": "Accepts a list of create/update/patch/delete operations (see the request model for more details).
\nEach operation can target a single or multiple milestones.
\nReturns a list of results for each input operation including errors.
\nGuarantees that the size and order of the returned results matches the order of input operations.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "bulkMilestones",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed milestones.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/MilestoneBulkAction"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MilestoneWithEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "[DEPRECATED: use custom fields of type 'milestone'] Perform multiple operations with milestones",
"tags": [
"CRUD",
"Milestones"
]
}
},
"/api/workspaces/{workspaceId}/milestones/list": {
"post": {
"deprecated": true,
"description": "Returns a list of milestones resolved for the provided IDs.
\nGuarantees that the array-size and order of the returned milestones matches the order of requested IDs.
\nDoes not fail if any of the requested milestones is not found or not accessible - instead it returns null as an array-element of the corresponding milestone which could not be accessed.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "listMilestones",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed milestones.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MilestoneWithEmbedOrNullList"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "[DEPRECATED: use custom fields of type 'milestone'] Retrieve multiple milestones by their IDs",
"tags": [
"CRUD",
"Milestones"
]
}
},
"/api/workspaces/{workspaceId}/milestones/search": {
"post": {
"deprecated": true,
"description": "Returns all milestones or searches milestones by query. Always returns only milestones which are accessible by the current user.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "searchMilestones",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed milestones.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "How many elements to skip.",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"description": "How many elements to return.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 1000,
"format": "int32",
"maximum": 1000,
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "From which element the page should start.",
"in": "query",
"name": "from",
"required": false,
"schema": {
"default": 0,
"deprecated": true,
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
{
"deprecated": true,
"description": "At which element the page should end (excluding it).",
"in": "query",
"name": "to",
"required": false,
"schema": {
"deprecated": true,
"format": "int32",
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MilestoneWithEmbedPage"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "bad_request",
"data": {},
"message": "Request body is invalid"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If payload is invalid."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "[DEPRECATED: use custom fields of type 'milestone'] Retrieve or search milestones",
"tags": [
"CRUD",
"Milestones"
]
}
},
"/api/workspaces/{workspaceId}/milestones/{milestoneId}": {
"delete": {
"deprecated": true,
"description": "Returns empty result if the milestone was successfully deleted.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "deleteMilestone",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed milestones.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "milestoneId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "[DEPRECATED: use custom fields of type 'milestone'] Delete an existing milestone",
"tags": [
"CRUD",
"Milestones"
]
},
"get": {
"deprecated": true,
"description": "Returns found milestone.
Requirements:
- auth-client scopes: \"workspace:read\"
- user permission: \"read\" or higher",
"operationId": "retrieveMilestone",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed milestones.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "milestoneId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MilestoneWithEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "[DEPRECATED: use custom fields of type 'milestone'] Retrieve a single milestone by its ID",
"tags": [
"CRUD",
"Milestones"
]
},
"patch": {
"deprecated": true,
"description": "Returns the whole updated milestone with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "patchMilestone",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed milestones.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "milestoneId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonPatch"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MilestoneWithEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "[DEPRECATED: use custom fields of type 'milestone'] Patch an existing milestone",
"tags": [
"CRUD",
"Milestones"
]
},
"put": {
"deprecated": true,
"description": "Returns updated milestone with its sanitised data.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "updateMilestone",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "ID of the workspace which contains the managed milestones.",
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "milestoneId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMilestoneRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MilestoneWithEmbed"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "[DEPRECATED: use custom fields of type 'milestone'] Update an existing milestone",
"tags": [
"CRUD",
"Milestones"
]
}
},
"/api/workspaces/{workspaceId}/permissions": {
"post": {
"description": "Returns effective permission for the current user.
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "updateWorkspacePermissions",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspacePermissionsUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Permission"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Update workspace permissions.",
"tags": [
"Workspaces"
]
}
},
"/api/workspaces/{workspaceId}/statuses": {
"post": {
"description": "Sets statuses (all at once) for the specified workspace.\nNew statuses in the list will be added to the database, missing statuses will be removed from the database, all other statuses will be updated.\nEach workspace must have at least one status in each category: 'draft', 'active', 'closed'
Requirements:
- auth-client scopes: \"workspace\"
- user permission: \"write\" or higher",
"operationId": "setWorkspaceStatuses",
"parameters": [
{
"deprecated": true,
"description": "Enable sudo-mode for admins for a single request, which gives full permission to all workspaces in the team.",
"in": "query",
"name": "actAsAdmin",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "path",
"name": "workspaceId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetWorkspaceStatusesRequest"
}
}
},
"required": true
},
"responses": {
"204": {
"description": ""
},
"400": {
"content": {
"application/json": {
"example": {
"code": "not_found",
"data": {},
"message": "Unknown entity 'fe4c0f30-aa35-3c41-99f9-a5f69c8c4192'"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If path parameters are invalid or payload is invalid or resource does not exist."
},
"401": {
"content": {
"application/json": {
"example": {
"code": "missing_token",
"data": {},
"message": "Access token is missing"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If missing authentication token."
},
"403": {
"content": {
"application/json": {
"example": {
"code": "forbidden",
"data": {},
"message": "Insufficient permission"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If user does not have the required permission, or authenticated client does not have the required access scopes."
},
"default": {
"content": {
"application/json": {
"example": {
"code": "unknown_error",
"data": {},
"message": "Server error"
},
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "If any other error happens."
}
},
"security": [
{
"httpAuth": []
}
],
"summary": "Configure workspace statuses.",
"tags": [
"Workspaces"
]
}
}
},
"servers": [
{
"url": "https://app.airfocus.com"
},
{
"url": "https://app.us.airfocus.com"
}
],
"tags": [
{
"description": "Endpoints for listing AI actors in a team.",
"name": "AI Actors"
},
{
"description": "Manage comments on items.",
"name": "Comments"
},
{
"description": "Endpoints for managing workspace fields.",
"name": "Fields"
},
{
"description": "Endpoints for global searching",
"name": "Global search"
},
{
"description": "Connect items with uploaded attachment-files. Note: this module is not responsible for uploading files, it only manages the links between items and files.",
"name": "ItemAttachments"
},
{
"description": "Endpoints for managing items.",
"name": "Items"
},
{
"description": "Endpoints for linking/unlinking items.",
"name": "Items:Links"
},
{
"description": "Endpoints for custom types of links between items.",
"name": "Items:Links:Types"
},
{
"description": "Endpoints for managing hierarchical relations between items.",
"name": "Items:Relations"
},
{
"description": "This module is deprecated. Use custom fields of type 'milestone' to manage milestones.",
"name": "Milestones"
},
{
"description": "Endpoints for managing user notification settings",
"name": "Notification Settings"
},
{
"description": "Endpoints for managing the user profile",
"name": "Profile"
},
{
"description": "Endpoints for managing reusable status presets.",
"name": "StatusPresets"
},
{
"description": "Endpoints for managing the team and users",
"name": "Team"
},
{
"description": "Endpoints for creating workspaces via templates.",
"name": "Templates"
},
{
"description": "Manage workspace groups.",
"name": "WorkspaceGroups"
},
{
"description": "Endpoints for managing workspaces.",
"name": "Workspaces"
}
]
}