openapi: 3.2.0 info: title: Opal Blocks API version: 3.0.0 license: name: Opal API License url: https://www.workwithopal.com/api-license description: 'Operations tagged Blocks across 2 of this provider''s published API definitions: opal-asgard-bff-openapi.yml, opal-v3-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://login.ouropal.com tags: - name: Blocks paths: /{workspace_id}/blocks/{block_id}: get: tags: - Blocks operationId: ReadBlockBFFV1 summary: Get a Block. security: - oauth2: - offline_access - api_key: - Session-Token parameters: - name: workspace_id in: path required: true description: The ID of the Block's workspace. schema: type: string format: uuid - name: block_id in: path required: true description: The ID of the Block. schema: type: string format: uuid responses: '200': description: The requested Block content: application/json: schema: type: object required: - data properties: data: type: object required: - boards - category - category_type - color - connectors - description - effective_privacy - last_updated_date - id - image_id - is_private - is_template - is_workspace_wide_template - owner_id - paired_moment_id - plan - rich_text_document_id - start_date - template_description - template_name - title - key_dates - child_plan - custom_fields - custom_field_values - inherited_custom_field_values - in_support_of_category_type_ids additionalProperties: false properties: boards: type: array description: Boards associated with this block. items: oneOf: - type: object title: Board required: - id - creator - description - image_source - is_public - title additionalProperties: false properties: id: type: string format: uuid title: type: string description: type: - string - 'null' image_source: type: - string - 'null' is_public: type: boolean creator: type: object description: The user that created the board. title: user required: - id - full_name - avatar_url - legacy_id additionalProperties: false properties: id: type: string format: uuid full_name: type: string avatar_url: type: - string - 'null' description: URL for the user's avatar. legacy_id: type: string description: The ID to be used with v2 APIs. category: description: Swimlane this block is placed in. type: - object - 'null' title: Swimlane required: - id - ancestor_titles - title additionalProperties: false properties: id: type: string format: uuid ancestor_titles: type: - array - 'null' items: type: - string - 'null' description: 'Titles of nested categories (''groups'') containing the swimlane, ordered from the root of the nesting to the swimlane''s parent. Categories without a title will be included as null. Currently our UI permits at most one ancestor, but consumers MUST be able to handle an arbitrary number of ancestors. (The specifics of how to present additional ancestors is up to the consumer.) ' title: type: - string - 'null' description: 'Title of the swimlane; null if the swimlane doesn''t have a title. ' category_type: type: - object - 'null' required: - id - name - description - deactivated_at additionalProperties: false properties: id: type: string format: uuid name: type: string description: The name that will be displayed in the Opal application UI. description: type: - string - 'null' description: A description of the record. deactivated_at: type: - string - 'null' format: date-time description: The timestamp when the category type was deactivated, if it has been deactivated. supported_paired_type: type: - string - 'null' default: null enum: - moment - null description: Whether blocks of this type will have resources of the given type paired with them. Moment pairing allows teams to work with the same resources from the Plan (via blocks) or from a Board or Calendar (via Moments). Once set to 'moment', this property cannot be set back to null. Blocks created with a type that supports moment pairing will always have paired moments. Conversely, blocks created with types that do not support moment pairing will not have paired moments (unless moment pairing support is added to the type later). color: type: - string - 'null' connectors: type: array items: type: object required: - id - category - parent_block - view properties: id: type: string format: uuid category: allOf: - type: object required: - id - name additionalProperties: false properties: id: type: string format: uuid name: type: - string - 'null' parent_block: type: object required: - id - name additionalProperties: false properties: id: type: string format: uuid name: type: - string - 'null' view: type: object required: - id - name additionalProperties: false properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' duration: type: - string - 'null' description: ISO 8601 duration string (e.g. P10D, P5W, P3M). Clients compute end date as start_date + duration. end_date: type: - string - 'null' format: date deprecated: true description: 'DEPRECATED: migrate to `duration`. An ISO8601 date describing the end of the block.' last_updated_date: type: string format: date-time description: An ISO8601 datetime describing the last time the block or its related resources was updated. effective_privacy: type: string enum: - whole_workspace - some_but_not_all description: 'The effective privacy of a block is calculated based on all direct and inherited access. If a block or any of its parents that it inherits access from are accessible to the entire workspace, the effective privacy is `whole_workspace`. Otherwise, the effective privacy is `some_but_not_all`. ' id: type: string format: uuid image_id: type: - string - 'null' format: uuid is_private: type: boolean description: 'DEPRECATED: Prefer using `effective_privacy`. Whether the block is private/invite-only (i.e. does not inherit from the workspace.) ' deprecated: true is_template: type: boolean description: Whether this block is a template. default: false is_workspace_wide_template: type: boolean description: Whether this template is available workspace-wide. default: false owner_id: type: string format: uuid paired_moment_id: type: - string - 'null' format: uuid description: The UUID of the paired moment, if one exists for this block. plan: description: Parent plan for this block. type: object title: Plan required: - id - title - start_at - end_at - start_month_index - start_weekday_index - colors - swimlanes - key_dates - valid_end_at - valid_start_at additionalProperties: false properties: id: type: string format: uuid title: type: string end_at: type: string format: date description: An ISO8601 date describing the end of the plan. start_at: type: string format: date description: An ISO8601 date describing the start of the plan. start_month_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 description: Start month index for the plan. Specifies the number of months, 0 to 11, to offset from January. 0 by default, meaning no offset. If set, e.g., 1, start in February. start_weekday_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 description: Start weekday index for the plan. Specifies the days in a week, 0 to 6 (Sunday to Saturday). 0 (Sunday) is the default. If set to, e.g., 1, weeks will start on Monday. colors: type: array description: List of colors present in the view. items: oneOf: - type: object required: - id - color - label additionalProperties: false properties: id: type: string format: uuid label: type: - string - 'null' color: type: string swimlanes: type: array description: List of all swimlanes on this plan. items: type: object title: Swimlane required: - id - ancestor_titles - title additionalProperties: false properties: id: type: string format: uuid ancestor_titles: type: - array - 'null' items: type: - string - 'null' description: 'Titles of nested categories (''groups'') containing the swimlane, ordered from the root of the nesting to the swimlane''s parent. Categories without a title will be included as null. Currently our UI permits at most one ancestor, but consumers MUST be able to handle an arbitrary number of ancestors. (The specifics of how to present additional ancestors is up to the consumer.) ' title: type: - string - 'null' description: 'Title of the swimlane; null if the swimlane doesn''t have a title. ' key_dates: type: array description: List of all the key dates on this plan. items: type: object title: Key Date required: - id - title - start_date - end_date - color additionalProperties: false properties: id: type: string format: uuid title: type: string description: A descriptive name for the key date start_date: type: string format: date description: The date that the key date begins to be observed. end_date: type: - string - 'null' format: date description: The date that the key date ceases to be observed. color: type: - string - 'null' description: A color for the key date. The value must be a HEX value in the format of '#FFF' or '#FFFFFF' parent_block: type: - object - 'null' description: 'The parent block of this plan. ' required: - boards - category - category_type - color - custom_fields - custom_field_values - description - inherited_custom_field_values - in_support_of_category_type_ids - is_private - is_template - is_workspace_wide_template - last_updated_date - id - image_id - owner_id - paired_moment_id - plan - rich_text_document_id - start_date - template_description - template_name - title - key_dates - child_plan - connectors additionalProperties: true properties: boards: type: array description: Boards associated with this block. items: oneOf: - type: object title: Board required: - id - creator - description - image_source - is_public - title additionalProperties: false properties: id: type: string format: uuid title: type: string description: type: - string - 'null' image_source: type: - string - 'null' is_public: type: boolean creator: type: object description: The user that created the board. title: user required: - id - full_name - avatar_url - legacy_id additionalProperties: false properties: id: type: string format: uuid full_name: type: string avatar_url: type: - string - 'null' description: URL for the user's avatar. legacy_id: type: string description: The ID to be used with v2 APIs. category: description: Swimlane this block is placed in. type: - object - 'null' title: Swimlane required: - id - ancestor_titles - title additionalProperties: false properties: id: type: string format: uuid ancestor_titles: type: - array - 'null' items: type: - string - 'null' description: 'Titles of nested categories (''groups'') containing the swimlane, ordered from the root of the nesting to the swimlane''s parent. Categories without a title will be included as null. Currently our UI permits at most one ancestor, but consumers MUST be able to handle an arbitrary number of ancestors. (The specifics of how to present additional ancestors is up to the consumer.) ' title: type: - string - 'null' description: 'Title of the swimlane; null if the swimlane doesn''t have a title. ' category_type: type: - object - 'null' required: - id - name - description - deactivated_at additionalProperties: false properties: id: type: string format: uuid name: type: string description: The name that will be displayed in the Opal application UI. description: type: - string - 'null' description: A description of the record. deactivated_at: type: - string - 'null' format: date-time description: The timestamp when the category type was deactivated, if it has been deactivated. supported_paired_type: type: - string - 'null' default: null enum: - moment - null description: Whether blocks of this type will have resources of the given type paired with them. Moment pairing allows teams to work with the same resources from the Plan (via blocks) or from a Board or Calendar (via Moments). Once set to 'moment', this property cannot be set back to null. Blocks created with a type that supports moment pairing will always have paired moments. Conversely, blocks created with types that do not support moment pairing will not have paired moments (unless moment pairing support is added to the type later). color: type: - string - 'null' connectors: type: array items: type: object required: - id - category - parent_block - view properties: id: type: string format: uuid category: allOf: - type: object required: - id - name additionalProperties: false properties: id: type: string format: uuid name: type: - string - 'null' parent_block: type: object required: - id - name additionalProperties: false properties: id: type: string format: uuid name: type: - string - 'null' view: type: object required: - id - name additionalProperties: false properties: id: type: string format: uuid name: type: - string - 'null' custom_fields: type: array description: Custom fields associated with this block. items: oneOf: - type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - date - multiSelect - url - usersSelect association_type: type: string enum: - direct - inherited description: Indicates whether the field is directly associated with the block or inherited from another source. options: type: array description: Active options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: type: object required: - id - value properties: id: type: string format: uuid value: oneOf: - title: Textarea type: object required: - value properties: value: type: string description: The text content. - title: Multi Select type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select type: object required: - id properties: id: type: string format: uuid description: The selected option ID. - title: Date type: object required: - value properties: value: type: string format: date-time description: The selected date. - title: URL type: object required: - url - label properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Display label for the URL. - title: Users Select type: object properties: user_ids: type: array items: type: string format: uuid description: An array of user UUID strings representing the selected users. group_ids: type: array items: type: string format: uuid description: An array of user group UUID strings representing the selected groups. custom_field_values: type: array description: Custom field values associated with this block. items: oneOf: - type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - date - multiSelect - url - usersSelect association_type: type: string enum: - direct - inherited description: Indicates whether the field is directly associated with the block or inherited from another source. options: type: array description: Active options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: type: object required: - id - value properties: id: type: string format: uuid value: oneOf: - title: Textarea type: object required: - value properties: value: type: string description: The text content. - title: Multi Select type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select type: object required: - id properties: id: type: string format: uuid description: The selected option ID. - title: Date type: object required: - value properties: value: type: string format: date-time description: The selected date. - title: URL type: object required: - url - label properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Display label for the URL. - title: Users Select type: object properties: user_ids: type: array items: type: string format: uuid description: An array of user UUID strings representing the selected users. group_ids: type: array items: type: string format: uuid description: An array of user group UUID strings representing the selected groups. description: type: - string - 'null' duration: type: - string - 'null' description: ISO 8601 duration string (e.g. P10D, P5W, P3M). Clients compute end date as start_date + duration. end_date: type: string format: date deprecated: true description: 'DEPRECATED: migrate to `duration`. An ISO8601 date describing the end of the block.' inherited_custom_field_values: type: array description: Custom field values cascaded down from a parent block type. items: oneOf: - type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - date - multiSelect - url - usersSelect association_type: type: string enum: - direct - inherited description: Indicates whether the field is directly associated with the block or inherited from another source. options: type: array description: Active options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: type: object required: - id - value properties: id: type: string format: uuid value: oneOf: - title: Textarea type: object required: - value properties: value: type: string description: The text content. - title: Multi Select type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select type: object required: - id properties: id: type: string format: uuid description: The selected option ID. - title: Date type: object required: - value properties: value: type: string format: date-time description: The selected date. - title: URL type: object required: - url - label properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Display label for the URL. - title: Users Select type: object properties: user_ids: type: array items: type: string format: uuid description: An array of user UUID strings representing the selected users. group_ids: type: array items: type: string format: uuid description: An array of user group UUID strings representing the selected groups. in_support_of_category_type_ids: type: array description: A list of IDs that the block's category_type has been configured to support. items: type: string format: uuid is_template: type: boolean description: Whether this block is a template. default: false is_workspace_wide_template: type: boolean description: Whether this template is available workspace-wide. default: false last_updated_date: type: string format: date-time description: An ISO8601 datetime describing the last time the block or its related resources was updated. id: type: string format: uuid image_id: type: - string - 'null' format: uuid owner_id: type: string format: uuid paired_moment_id: type: - string - 'null' format: uuid description: The UUID of the paired moment, if one exists for this block. plan: description: The parent plan for this block. type: - object - 'null' title: Plan required: - id - title - start_at - end_at - start_month_index - colors - swimlanes - key_dates additionalProperties: false properties: id: type: string format: uuid title: type: string end_at: type: string format: date description: An ISO8601 date describing the end of the plan. start_at: type: string format: date description: An ISO8601 date describing the start of the plan. start_month_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 description: Start month index for the plan. Specifies the number of months, 0 to 11, to offset from January. 0 by default, meaning no offset. If set, e.g., 1, start in February. colors: type: array description: List of colors present in the view. items: oneOf: - type: object required: - id - color - label additionalProperties: false properties: id: type: string format: uuid label: type: - string - 'null' color: type: string swimlanes: type: array description: List of all swimlanes on this plan. items: type: object title: Swimlane required: - id - ancestor_titles - title additionalProperties: false properties: id: type: string format: uuid ancestor_titles: type: - array - 'null' items: type: - string - 'null' description: 'Titles of nested categories (''groups'') containing the swimlane, ordered from the root of the nesting to the swimlane''s parent. Categories without a title will be included as null. Currently our UI permits at most one ancestor, but consumers MUST be able to handle an arbitrary number of ancestors. (The specifics of how to present additional ancestors is up to the consumer.) ' title: type: - string - 'null' description: 'Title of the swimlane; null if the swimlane doesn''t have a title. ' key_dates: type: array description: List of all the key dates on this plan. items: type: object title: Key Date required: - id - title - start_date - end_date - color additionalProperties: false properties: id: type: string format: uuid title: type: string description: A descriptive name for the key date start_date: type: string format: date description: The date that the key date begins to be observed. end_date: type: - string - 'null' format: date description: The date that the key date ceases to be observed. color: type: - string - 'null' description: A color for the key date. The value must be a HEX value in the format of '#FFF' or '#FFFFFF' parent_block: type: - object - 'null' description: The parent block of this plan. child_plan: description: Child plan for this block. type: - object - 'null' title: Plan required: - id - title - start_at - end_at - start_month_index - colors - swimlanes - key_dates additionalProperties: false properties: id: type: string format: uuid title: type: string end_at: type: string format: date description: An ISO8601 date describing the end of the plan. start_at: type: string format: date description: An ISO8601 date describing the start of the plan. start_month_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 description: Start month index for the plan. Specifies the number of months, 0 to 11, to offset from January. 0 by default, meaning no offset. If set, e.g., 1, start in February. colors: type: array description: List of colors present in the view. items: oneOf: - type: object required: - id - color - label additionalProperties: false properties: id: type: string format: uuid label: type: - string - 'null' color: type: string swimlanes: type: array description: List of all swimlanes on this plan. items: type: object title: Swimlane required: - id - ancestor_titles - title additionalProperties: false properties: id: type: string format: uuid ancestor_titles: type: - array - 'null' items: type: - string - 'null' description: 'Titles of nested categories (''groups'') containing the swimlane, ordered from the root of the nesting to the swimlane''s parent. Categories without a title will be included as null. Currently our UI permits at most one ancestor, but consumers MUST be able to handle an arbitrary number of ancestors. (The specifics of how to present additional ancestors is up to the consumer.) ' title: type: - string - 'null' description: 'Title of the swimlane; null if the swimlane doesn''t have a title. ' key_dates: type: array description: List of all the key dates on this plan. items: type: object title: Key Date required: - id - title - start_date - end_date - color additionalProperties: false properties: id: type: string format: uuid title: type: string description: A descriptive name for the key date start_date: type: string format: date description: The date that the key date begins to be observed. end_date: type: - string - 'null' format: date description: The date that the key date ceases to be observed. color: type: - string - 'null' description: A color for the key date. The value must be a HEX value in the format of '#FFF' or '#FFFFFF' parent_block: type: - object - 'null' description: The parent block of this plan. rich_text_document_id: type: string format: uuid start_date: type: string format: date description: An ISO8601 date describing the start of the block. template_description: type: - string - 'null' description: Description of the template when `is_template` is `true`. template_name: type: - string - 'null' description: Name of the template when `is_template` is `true`. title: type: string key_dates: type: array description: Key Dates on the Plan which have a `start_date` within the Block's date range (start_date to start_date + duration). items: oneOf: - type: object title: Key Date required: - id - title - start_date - end_date - color additionalProperties: false properties: id: type: string format: uuid title: type: string description: A descriptive name for the key date start_date: type: string format: date description: The date that the key date begins to be observed. end_date: type: - string - 'null' format: date description: The date that the key date ceases to be observed. color: type: - string - 'null' description: A color for the key date. The value must be a HEX value in the format of '#FFF' or '#FFFFFF' valid_end_at: type: - string - 'null' format: date description: An ISO8601 date describing the earliest valid end of the plan. valid_start_at: type: - string - 'null' format: date description: An ISO8601 date describing the latest valid start of the plan. child_plan: description: Child plan for this block. type: - object - 'null' title: Plan required: - id - title - start_at - end_at - start_month_index - start_weekday_index - colors - swimlanes - key_dates - valid_end_at - valid_start_at additionalProperties: false properties: id: type: string format: uuid title: type: string end_at: type: string format: date description: An ISO8601 date describing the end of the plan. start_at: type: string format: date description: An ISO8601 date describing the start of the plan. start_month_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 description: Start month index for the plan. Specifies the number of months, 0 to 11, to offset from January. 0 by default, meaning no offset. If set, e.g., 1, start in February. start_weekday_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 description: Start weekday index for the plan. Specifies the days in a week, 0 to 6 (Sunday to Saturday). 0 (Sunday) is the default. If set to, e.g., 1, weeks will start on Monday. colors: type: array description: List of colors present in the view. items: oneOf: - type: object required: - id - color - label additionalProperties: false properties: id: type: string format: uuid label: type: - string - 'null' color: type: string swimlanes: type: array description: List of all swimlanes on this plan. items: type: object title: Swimlane required: - id - ancestor_titles - title additionalProperties: false properties: id: type: string format: uuid ancestor_titles: type: - array - 'null' items: type: - string - 'null' description: 'Titles of nested categories (''groups'') containing the swimlane, ordered from the root of the nesting to the swimlane''s parent. Categories without a title will be included as null. Currently our UI permits at most one ancestor, but consumers MUST be able to handle an arbitrary number of ancestors. (The specifics of how to present additional ancestors is up to the consumer.) ' title: type: - string - 'null' description: 'Title of the swimlane; null if the swimlane doesn''t have a title. ' key_dates: type: array description: List of all the key dates on this plan. items: type: object title: Key Date required: - id - title - start_date - end_date - color additionalProperties: false properties: id: type: string format: uuid title: type: string description: A descriptive name for the key date start_date: type: string format: date description: The date that the key date begins to be observed. end_date: type: - string - 'null' format: date description: The date that the key date ceases to be observed. color: type: - string - 'null' description: A color for the key date. The value must be a HEX value in the format of '#FFF' or '#FFFFFF' parent_block: type: - object - 'null' description: 'The parent block of this plan. ' required: - boards - category - category_type - color - custom_fields - custom_field_values - description - inherited_custom_field_values - in_support_of_category_type_ids - is_private - is_template - is_workspace_wide_template - last_updated_date - id - image_id - owner_id - paired_moment_id - plan - rich_text_document_id - start_date - template_description - template_name - title - key_dates - child_plan - connectors additionalProperties: true properties: boards: type: array description: Boards associated with this block. items: oneOf: - type: object title: Board required: - id - creator - description - image_source - is_public - title additionalProperties: false properties: id: type: string format: uuid title: type: string description: type: - string - 'null' image_source: type: - string - 'null' is_public: type: boolean creator: type: object description: The user that created the board. title: user required: - id - full_name - avatar_url - legacy_id additionalProperties: false properties: id: type: string format: uuid full_name: type: string avatar_url: type: - string - 'null' description: URL for the user's avatar. legacy_id: type: string description: The ID to be used with v2 APIs. category: description: Swimlane this block is placed in. type: - object - 'null' title: Swimlane required: - id - ancestor_titles - title additionalProperties: false properties: id: type: string format: uuid ancestor_titles: type: - array - 'null' items: type: - string - 'null' description: 'Titles of nested categories (''groups'') containing the swimlane, ordered from the root of the nesting to the swimlane''s parent. Categories without a title will be included as null. Currently our UI permits at most one ancestor, but consumers MUST be able to handle an arbitrary number of ancestors. (The specifics of how to present additional ancestors is up to the consumer.) ' title: type: - string - 'null' description: 'Title of the swimlane; null if the swimlane doesn''t have a title. ' category_type: type: - object - 'null' required: - id - name - description - deactivated_at additionalProperties: false properties: id: type: string format: uuid name: type: string description: The name that will be displayed in the Opal application UI. description: type: - string - 'null' description: A description of the record. deactivated_at: type: - string - 'null' format: date-time description: The timestamp when the category type was deactivated, if it has been deactivated. supported_paired_type: type: - string - 'null' default: null enum: - moment - null description: Whether blocks of this type will have resources of the given type paired with them. Moment pairing allows teams to work with the same resources from the Plan (via blocks) or from a Board or Calendar (via Moments). Once set to 'moment', this property cannot be set back to null. Blocks created with a type that supports moment pairing will always have paired moments. Conversely, blocks created with types that do not support moment pairing will not have paired moments (unless moment pairing support is added to the type later). color: type: - string - 'null' connectors: type: array items: type: object required: - id - category - parent_block - view properties: id: type: string format: uuid category: allOf: - type: object required: - id - name additionalProperties: false properties: id: type: string format: uuid name: type: - string - 'null' parent_block: type: object required: - id - name additionalProperties: false properties: id: type: string format: uuid name: type: - string - 'null' view: type: object required: - id - name additionalProperties: false properties: id: type: string format: uuid name: type: - string - 'null' custom_fields: type: array description: Custom fields associated with this block. items: oneOf: - type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - date - multiSelect - url - usersSelect association_type: type: string enum: - direct - inherited description: Indicates whether the field is directly associated with the block or inherited from another source. options: type: array description: Active options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: type: object required: - id - value properties: id: type: string format: uuid value: oneOf: - title: Textarea type: object required: - value properties: value: type: string description: The text content. - title: Multi Select type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select type: object required: - id properties: id: type: string format: uuid description: The selected option ID. - title: Date type: object required: - value properties: value: type: string format: date-time description: The selected date. - title: URL type: object required: - url - label properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Display label for the URL. - title: Users Select type: object properties: user_ids: type: array items: type: string format: uuid description: An array of user UUID strings representing the selected users. group_ids: type: array items: type: string format: uuid description: An array of user group UUID strings representing the selected groups. custom_field_values: type: array description: Custom field values associated with this block. items: oneOf: - type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - date - multiSelect - url - usersSelect association_type: type: string enum: - direct - inherited description: Indicates whether the field is directly associated with the block or inherited from another source. options: type: array description: Active options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: type: object required: - id - value properties: id: type: string format: uuid value: oneOf: - title: Textarea type: object required: - value properties: value: type: string description: The text content. - title: Multi Select type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select type: object required: - id properties: id: type: string format: uuid description: The selected option ID. - title: Date type: object required: - value properties: value: type: string format: date-time description: The selected date. - title: URL type: object required: - url - label properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Display label for the URL. - title: Users Select type: object properties: user_ids: type: array items: type: string format: uuid description: An array of user UUID strings representing the selected users. group_ids: type: array items: type: string format: uuid description: An array of user group UUID strings representing the selected groups. description: type: - string - 'null' duration: type: - string - 'null' description: ISO 8601 duration string (e.g. P10D, P5W, P3M). Clients compute end date as start_date + duration. end_date: type: string format: date deprecated: true description: 'DEPRECATED: migrate to `duration`. An ISO8601 date describing the end of the block.' inherited_custom_field_values: type: array description: Custom field values cascaded down from a parent block type. items: oneOf: - type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - date - multiSelect - url - usersSelect association_type: type: string enum: - direct - inherited description: Indicates whether the field is directly associated with the block or inherited from another source. options: type: array description: Active options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: type: object required: - id - value properties: id: type: string format: uuid value: oneOf: - title: Textarea type: object required: - value properties: value: type: string description: The text content. - title: Multi Select type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select type: object required: - id properties: id: type: string format: uuid description: The selected option ID. - title: Date type: object required: - value properties: value: type: string format: date-time description: The selected date. - title: URL type: object required: - url - label properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Display label for the URL. - title: Users Select type: object properties: user_ids: type: array items: type: string format: uuid description: An array of user UUID strings representing the selected users. group_ids: type: array items: type: string format: uuid description: An array of user group UUID strings representing the selected groups. in_support_of_category_type_ids: type: array description: A list of IDs that the block's category_type has been configured to support. items: type: string format: uuid is_template: type: boolean description: Whether this block is a template. default: false is_workspace_wide_template: type: boolean description: Whether this template is available workspace-wide. default: false last_updated_date: type: string format: date-time description: An ISO8601 datetime describing the last time the block or its related resources was updated. id: type: string format: uuid image_id: type: - string - 'null' format: uuid owner_id: type: string format: uuid paired_moment_id: type: - string - 'null' format: uuid description: The UUID of the paired moment, if one exists for this block. plan: description: The parent plan for this block. type: - object - 'null' title: Plan required: - id - title - start_at - end_at - start_month_index - colors - swimlanes - key_dates additionalProperties: false properties: id: type: string format: uuid title: type: string end_at: type: string format: date description: An ISO8601 date describing the end of the plan. start_at: type: string format: date description: An ISO8601 date describing the start of the plan. start_month_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 description: Start month index for the plan. Specifies the number of months, 0 to 11, to offset from January. 0 by default, meaning no offset. If set, e.g., 1, start in February. colors: type: array description: List of colors present in the view. items: oneOf: - type: object required: - id - color - label additionalProperties: false properties: id: type: string format: uuid label: type: - string - 'null' color: type: string swimlanes: type: array description: List of all swimlanes on this plan. items: type: object title: Swimlane required: - id - ancestor_titles - title additionalProperties: false properties: id: type: string format: uuid ancestor_titles: type: - array - 'null' items: type: - string - 'null' description: 'Titles of nested categories (''groups'') containing the swimlane, ordered from the root of the nesting to the swimlane''s parent. Categories without a title will be included as null. Currently our UI permits at most one ancestor, but consumers MUST be able to handle an arbitrary number of ancestors. (The specifics of how to present additional ancestors is up to the consumer.) ' title: type: - string - 'null' description: 'Title of the swimlane; null if the swimlane doesn''t have a title. ' key_dates: type: array description: List of all the key dates on this plan. items: type: object title: Key Date required: - id - title - start_date - end_date - color additionalProperties: false properties: id: type: string format: uuid title: type: string description: A descriptive name for the key date start_date: type: string format: date description: The date that the key date begins to be observed. end_date: type: - string - 'null' format: date description: The date that the key date ceases to be observed. color: type: - string - 'null' description: A color for the key date. The value must be a HEX value in the format of '#FFF' or '#FFFFFF' parent_block: type: - object - 'null' description: The parent block of this plan. child_plan: description: Child plan for this block. type: - object - 'null' title: Plan required: - id - title - start_at - end_at - start_month_index - colors - swimlanes - key_dates additionalProperties: false properties: id: type: string format: uuid title: type: string end_at: type: string format: date description: An ISO8601 date describing the end of the plan. start_at: type: string format: date description: An ISO8601 date describing the start of the plan. start_month_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 description: Start month index for the plan. Specifies the number of months, 0 to 11, to offset from January. 0 by default, meaning no offset. If set, e.g., 1, start in February. colors: type: array description: List of colors present in the view. items: oneOf: - type: object required: - id - color - label additionalProperties: false properties: id: type: string format: uuid label: type: - string - 'null' color: type: string swimlanes: type: array description: List of all swimlanes on this plan. items: type: object title: Swimlane required: - id - ancestor_titles - title additionalProperties: false properties: id: type: string format: uuid ancestor_titles: type: - array - 'null' items: type: - string - 'null' description: 'Titles of nested categories (''groups'') containing the swimlane, ordered from the root of the nesting to the swimlane''s parent. Categories without a title will be included as null. Currently our UI permits at most one ancestor, but consumers MUST be able to handle an arbitrary number of ancestors. (The specifics of how to present additional ancestors is up to the consumer.) ' title: type: - string - 'null' description: 'Title of the swimlane; null if the swimlane doesn''t have a title. ' key_dates: type: array description: List of all the key dates on this plan. items: type: object title: Key Date required: - id - title - start_date - end_date - color additionalProperties: false properties: id: type: string format: uuid title: type: string description: A descriptive name for the key date start_date: type: string format: date description: The date that the key date begins to be observed. end_date: type: - string - 'null' format: date description: The date that the key date ceases to be observed. color: type: - string - 'null' description: A color for the key date. The value must be a HEX value in the format of '#FFF' or '#FFFFFF' parent_block: type: - object - 'null' description: The parent block of this plan. rich_text_document_id: type: string format: uuid start_date: type: string format: date description: An ISO8601 date describing the start of the block. template_description: type: - string - 'null' description: Description of the template when `is_template` is `true`. template_name: type: - string - 'null' description: Name of the template when `is_template` is `true`. title: type: string key_dates: type: array description: Key Dates on the Plan which have a `start_date` within the Block's date range (start_date to start_date + duration). items: oneOf: - type: object title: Key Date required: - id - title - start_date - end_date - color additionalProperties: false properties: id: type: string format: uuid title: type: string description: A descriptive name for the key date start_date: type: string format: date description: The date that the key date begins to be observed. end_date: type: - string - 'null' format: date description: The date that the key date ceases to be observed. color: type: - string - 'null' description: A color for the key date. The value must be a HEX value in the format of '#FFF' or '#FFFFFF' valid_end_at: type: - string - 'null' format: date description: An ISO8601 date describing the earliest valid end of the plan. valid_start_at: type: - string - 'null' format: date description: An ISO8601 date describing the latest valid start of the plan. rich_text_document_id: type: string format: uuid start_date: type: - string - 'null' format: date description: An ISO8601 date describing the start of the block. template_description: type: - string - 'null' description: Description of the template when `is_template` is `true`. template_name: type: - string - 'null' description: Name of the template when `is_template` is `true`. title: type: string key_dates: type: array description: Key Dates on the Plan which have a `start_date` within the Block's date range (start_date to start_date + duration). items: oneOf: - type: object title: Key Date required: - id - title - start_date - end_date - color additionalProperties: false properties: id: type: string format: uuid title: type: string description: A descriptive name for the key date start_date: type: string format: date description: The date that the key date begins to be observed. end_date: type: - string - 'null' format: date description: The date that the key date ceases to be observed. color: type: - string - 'null' description: A color for the key date. The value must be a HEX value in the format of '#FFF' or '#FFFFFF' custom_fields: type: array description: Custom fields associated with this block. items: oneOf: - type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - date - multiSelect - url - usersSelect association_type: type: string enum: - direct - inherited description: Indicates whether the field is directly associated with the block or inherited from another source. options: type: array description: Active options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: type: object required: - id - value properties: id: type: string format: uuid value: oneOf: - title: Textarea type: object required: - value properties: value: type: string description: The text content. - title: Multi Select type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select type: object required: - id properties: id: type: string format: uuid description: The selected option ID. - title: Date type: object required: - value properties: value: type: string format: date-time description: The selected date. - title: URL type: object required: - url - label properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Display label for the URL. - title: Users Select type: object properties: user_ids: type: array items: type: string format: uuid description: An array of user UUID strings representing the selected users. group_ids: type: array items: type: string format: uuid description: An array of user group UUID strings representing the selected groups. custom_field_values: type: array description: Custom field values associated with this block. items: oneOf: - type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - date - multiSelect - url - usersSelect association_type: type: string enum: - direct - inherited description: Indicates whether the field is directly associated with the block or inherited from another source. options: type: array description: Active options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: type: object required: - id - value properties: id: type: string format: uuid value: oneOf: - title: Textarea type: object required: - value properties: value: type: string description: The text content. - title: Multi Select type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select type: object required: - id properties: id: type: string format: uuid description: The selected option ID. - title: Date type: object required: - value properties: value: type: string format: date-time description: The selected date. - title: URL type: object required: - url - label properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Display label for the URL. - title: Users Select type: object properties: user_ids: type: array items: type: string format: uuid description: An array of user UUID strings representing the selected users. group_ids: type: array items: type: string format: uuid description: An array of user group UUID strings representing the selected groups. inherited_custom_field_values: type: array description: Custom field values cascaded down from a parent block type. items: oneOf: - type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - date - multiSelect - url - usersSelect association_type: type: string enum: - direct - inherited description: Indicates whether the field is directly associated with the block or inherited from another source. options: type: array description: Active options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: type: object required: - id - value properties: id: type: string format: uuid value: oneOf: - title: Textarea type: object required: - value properties: value: type: string description: The text content. - title: Multi Select type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select type: object required: - id properties: id: type: string format: uuid description: The selected option ID. - title: Date type: object required: - value properties: value: type: string format: date-time description: The selected date. - title: URL type: object required: - url - label properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Display label for the URL. - title: Users Select type: object properties: user_ids: type: array items: type: string format: uuid description: An array of user UUID strings representing the selected users. group_ids: type: array items: type: string format: uuid description: An array of user group UUID strings representing the selected groups. in_support_of_category_type_ids: type: array description: A list of IDs that the block's category_type has been configured to support. items: type: string format: uuid example: data: color: '#00A148' description: Halloween Fun duration: P30D end_date: '2024-10-31T00:00:00.000Z' last_updated_date: '2024-06-02T08:14:23.345Z' id: a299d65c-959d-433d-bd8c-3e5b8ba4f763 image_id: 3e5b8ba4f763-959d-433d-bd8c-a299d65c is_template: false is_workspace_wide_template: false owner_id: 4eea039c-3f5d-4f2d-baa3-126b2933a024 template_description: null template_name: null paired_moment_id: ca065865-5edc-4246-8fa7-97bb98a23307 start_date: '2024-10-01T00:00:00.000Z' title: Halloween 2024 category: id: 8d3e65de-d457-4653-a859-45d4867cb1cd ancestor_titles: - Swimlane Group A title: Swimlane A1 plan: id: e5fce736-a506-4328-8d53-31fc055aafea title: Global Plan 2024 start_month_index: 0 start_weekday_index: 0 swimlanes: - id: 8d3e65de-d457-4653-a859-45d4867cb1cd ancestor_titles: - Swimlane Group A - null title: Swimlane A1 - id: 11c88733-ecbb-4f7c-ab40-b391cf1e7b3e ancestor_titles: - Swimlane Group B title: Swimlane B1 - id: 6f3d8458-7a25-49cd-b6e9-279ec2ae76e5 ancestor_titles: - Swimlane Group B title: Swimlane B2 - id: 694c9624-abe0-4ae0-80f2-0bf43d68f0b5 ancestor_titles: null title: Top Level Swimlane - id: ea7b07a5-1e13-4057-9fcc-8d927b53323e ancestor_titles: null title: null key_dates: - id: ec697303-3586-4352-927f-66736ccbc9ea title: Halloween color: '#FF0000' start_date: '2024-10-31' end_date: null - id: 2b60fc0f-8f86-4922-8ca5-8ed573a3b7eb title: Not Halloween color: null start_date: '2024-11-01' end_date: null colors: - id: c790b741-636b-4af8-80fd-6455802ecdd5 label: Green color: '#3BB273' rich_text_document_id: c5f3e736-a506-4328-8d53-31fc055aafea key_dates: - id: ec697303-3586-4352-927f-66736ccbc9ea title: Halloween color: '#FF0000' start_date: '2024-10-31' end_date: null category_type: deactivated_at: null description: Cost Centers id: 3757333e-109a-4365-81c2-50a957f13477 name: Department supported_paired_type: null custom_field_values: - association_type: inherited data: null deactivated_options: - display_name: drive id: 6f245196-df88-447b-8130-8a058625c88e display_name: Multi Select Dropdown visionary id: 70d42722-8f7a-402d-a5ce-3858d664e360 options: - display_name: enable id: 2719868e-7660-4229-a3f8-7dbb330f5fb4 - display_name: engage id: 63e3e818-8f39-4726-8cb5-27822aede64b type: multiSelect - association_type: inherited data: null deactivated_options: - display_name: monetize id: b197ecb6-b24f-4bbb-b758-a150c28aeea8 display_name: Single Select Dropdown efficient id: f697098b-c2cb-4429-b564-7905fca0e1fa options: - display_name: engineer id: bff8566c-5ad3-4f50-a43d-b73718dd8e38 - display_name: envisioneer id: 9deb3a0a-3b5f-445a-95d0-3b13defb37be type: singleSelect boards: - id: a9f38c4d-8a3c-439c-8344-aaed38e659ca description: null title: A New Board creator: id: 4eea039c-3f5d-4f2d-baa3-126b2933a024 legacy_id: '30' full_name: Gaylene Treutel avatar_url: null image_source: null is_public: false child_plan: id: e01b9a23-01f4-447d-96fd-03188fc9edd1 title: Nested View colors: - id: 15465a29-2934-458a-94e6-58597a41f185 label: Green color: '#3BB273' key_dates: [] end_at: '2025-01-15' start_at: '2025-01-01' swimlanes: [] start_month_index: 0 start_weekday_index: 0 parent_block: null in_support_of_category_type_ids: - b69138d6-be91-44f7-b6ef-6e9c5abed51d '401': description: Unauthorized content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status '403': description: Forbidden content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status '404': description: Not found content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status servers: - url: https://login.ouropal.com /{workspace_id}/blocks: get: tags: - Blocks operationId: ReadBlocksBFFV1 summary: Get a collection of Blocks. security: - oauth2: - offline_access - api_key: - Session-Token parameters: - name: workspace_id in: path required: true description: The ID of the Block's workspace. schema: type: string format: uuid - name: filter in: query description: 'Filters for limiting the results. ' required: false schema: type: object properties: has_child_view: type: boolean description: 'Boolean true returns blocks with child views, while boolean false returns blocks without child views. Omission will return all blocks. ' is_nested: type: boolean description: 'Boolean true returns nested blocks, while boolean false returns top-level blocks. Omission will return all blocks. ' browsable: type: boolean description: 'Boolean true returns browsable blocks, while boolean false returns non-browsable blocks. Omission will return all blocks. The concept of browsability determines if a block is eligible for dispaly in directory views (like the Plans Directory). Frontend logic should use this property instead of whether a block is nested to determine if that block should be shown in the Plans Directory. ' is_template: type: boolean description: When `false` or omitted only returns blocks. When `true` only returns block templates. default: false is_workspace_wide_template: type: boolean description: 'When `true` only returns workspace-wide templates. MUST be used together with `is_template=true`.' default: false plan_id: type: string format: uuid description: Limits results to a single plan style: deepObject explode: true responses: '200': description: The requested blocks content: application/json: schema: type: object required: - data properties: data: type: array items: type: object required: - category_type - created_at - description - effective_privacy - id - image_id - is_template - is_workspace_wide_template - last_updated_date - owner - start_date - template_description - template_name - title - child_view_id - connectors additionalProperties: false properties: category_type: type: - object - 'null' required: - id - name - description - deactivated_at additionalProperties: false properties: id: type: string format: uuid name: type: string description: The name that will be displayed in the Opal application UI. description: type: - string - 'null' description: A description of the record. deactivated_at: type: - string - 'null' format: date-time description: The timestamp when the category type was deactivated, if it has been deactivated. supported_paired_type: type: - string - 'null' default: null enum: - moment - null description: Whether blocks of this type will have resources of the given type paired with them. Moment pairing allows teams to work with the same resources from the Plan (via blocks) or from a Board or Calendar (via Moments). Once set to 'moment', this property cannot be set back to null. Blocks created with a type that supports moment pairing will always have paired moments. Conversely, blocks created with types that do not support moment pairing will not have paired moments (unless moment pairing support is added to the type later). created_at: type: string format: date-time description: An ISO8601 datetime describing when the block was created. description: type: - string - 'null' duration: type: - string - 'null' description: ISO 8601 duration string (e.g. P10D, P5W, P3M). Clients compute end date as start_date + duration. end_date: type: - string - 'null' format: date deprecated: true description: 'DEPRECATED: migrate to `duration`. An ISO8601 date describing the end of the block.' effective_privacy: type: string enum: - whole_workspace - some_but_not_all description: 'The effective privacy of a block is calculated based on all direct and inherited access. If a block or any of its parents that it inherits access from are accessible to the entire workspace, the effective privacy is `whole_workspace`. Otherwise, the effective privacy is `some_but_not_all`. ' id: type: string format: uuid image_id: type: - string - 'null' format: uuid is_template: type: boolean description: Whether this block is a template. is_workspace_wide_template: type: boolean description: Whether this template is available workspace-wide. default: false last_updated_date: type: string format: date-time description: An ISO8601 datetime describing the last time the block or its related resources was updated. owner: title: user type: object required: - id - full_name - avatar_url - legacy_id additionalProperties: false properties: id: type: string format: uuid full_name: type: string avatar_url: type: - string - 'null' description: URL for the user's avatar. legacy_id: type: string description: The ID to be used with v2 APIs. start_date: type: - string - 'null' format: date description: An ISO8601 date describing the start of the block. template_description: type: - string - 'null' description: Description of the template when `is_template` is `true`. template_name: type: - string - 'null' description: Name of the template when `is_template` is `true`. title: type: string child_view_id: type: - string - 'null' format: uuid description: The UUID of the view (plan) associated with the block, if one exists for this block. connectors: type: array items: type: object required: - id - category - parent_block - view properties: id: type: string format: uuid category: allOf: - type: object required: - id - name additionalProperties: false properties: id: type: string format: uuid name: type: - string - 'null' parent_block: type: object required: - id - name additionalProperties: false properties: id: type: string format: uuid name: type: - string - 'null' view: type: object required: - id - name additionalProperties: false properties: id: type: string format: uuid name: type: - string - 'null' '401': description: Unauthorized content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status '403': description: Forbidden content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status '404': description: Not found content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status servers: - url: https://login.ouropal.com /{workspace_id}/blocks/{block_id}/connector_candidates: get: tags: - Blocks operationId: ReadBlockConnectorCandidatesBFFV1 summary: Get a block's connector candidates. security: - oauth2: - offline_access - api_key: - Session-Token parameters: - name: workspace_id in: path required: true description: The ID of the Block's workspace. schema: type: string format: uuid - name: block_id in: path required: true description: The ID of the Block. schema: type: string format: uuid - name: all_blocks in: query required: false description: Returns all blocks instead of category type filtered blocks. schema: type: boolean responses: '200': description: The requested Block Connector Candidates content: application/json: schema: type: object required: - data properties: data: type: array items: type: object required: - block - supportive_category_id - supportive_view_id - child_candidates - category_type - start_date - end_date additionalProperties: false properties: block: type: object required: - id - name additionalProperties: false properties: id: type: string format: uuid name: type: - string - 'null' category_type: type: - object - 'null' required: - id - name additionalProperties: false properties: id: type: string format: uuid name: type: - string - 'null' supportive_category_id: type: - string - 'null' format: uuid supportive_view_id: type: - string - 'null' format: uuid start_date: type: string format: date end_date: type: string format: date child_candidates: type: - array - 'null' items: type: object required: - block - supportive_category_id - supportive_view_id - child_candidates additionalProperties: false properties: block: type: object required: - id - name additionalProperties: false properties: id: type: string format: uuid name: type: - string - 'null' supportive_category_id: type: - string - 'null' format: uuid supportive_view_id: type: - string - 'null' format: uuid child_candidates: type: - string - 'null' example: data: - block: id: 193fd135-efe2-47a4-9770-8c29caf68613 name: Top Level Block 1 supportive_category_id: a04e09c0-fdd4-4c38-b378-cad73ef41b01 supportive_view_id: a559db65-936b-4377-9ae7-718b723acf62 child_candidates: - block: id: cf2a3893-822a-4053-a04c-9e0b9817e0ed name: Child Block 1 supportive_category_id: bce9dff6-e8de-4069-a583-a5c84db58475 supportive_view_id: 3c3e931d-a3db-494c-be8c-25cb96724024 child_candidates: null - block: id: 0e9db2c1-182b-47e8-9aad-223c2f3ebb1b name: Child Block 2 supportive_category_id: bce9dff6-e8de-4069-a583-a5c84db58475 supportive_view_id: 3c3e931d-a3db-494c-be8c-25cb96724024 child_candidates: null - block: id: 28420deb-303d-473f-a2bd-1eabcd9c4b90 name: Top Level Block 2 supportive_category_id: 7550523d-0db2-4025-99c1-0c8fda104adf supportive_view_id: 480fe0df-2aa6-47c0-9780-c836bd818480 child_candidates: null '400': description: Bad request content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status '401': description: Unauthorized content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status '403': description: Forbidden content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status '404': description: Not found content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status '500': description: Internal Server Error content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status servers: - url: https://login.ouropal.com /loupe/v3/blocks: get: tags: - Blocks operationId: ReadBlocksV3 x-Operation-ID: ReadBlocksV3 summary: Get the blocks available to the authenticated user security: - oauth2: - offline_access - api_key: [] parameters: - name: filter in: query description: 'Filters for limiting the results. ' required: true schema: type: object required: - workspace_id properties: board_id: type: array items: type: string format: uuid description: 'The IDs of the boards to which results should be filtered. For example, `filter[board_id]=d19806fe-55b3-4682-9d67-07343fea3975` will fetch all accessible blocks associated with board `d19806fe-55b3-4682-9d67-07343fea3975` ' custom_field_option_value: oneOf: - type: array items: type: string format: uuid - type: object properties: and: type: array items: type: string format: uuid - type: object properties: or: type: array items: type: string format: uuid description: 'The IDs of custom field options for which results should be filtered. Multiple IDs can be provided as a comma separated string. To be considered valid, a block must have any one of the custom field options provided set as a value for that custom field. The behavior of this filter can be changed to requiring all specified properties are set by using `filter[custom_field_option_value][and]={{uuids}}`. ' category_id: type: - array - 'null' items: type: string format: uuid description: 'The IDs of the categories to which results should be filtered. Multiple IDs should be comma-separated. If set to "null", all accessible blocks without associated categories will be returned. ' category_type_id: type: - array - 'null' items: type: string format: uuid description: 'The IDs of the category types to which results should be filtered. Multiple IDs should be comma-separated. If set to "null", all accessible blocks without associated category types will be returned. ' filter_set_id: type: string format: uuid description: 'The ID of a filter set to use as a block filter. The filter set must have a resource_type of `block` to be valid. **Note:** The `filter[filter_set_filter]` parameter will be overriden by this option if both are provided. ' filter_set_filter: type: string description: 'A serialized JSON object representing a filter set `filter` to use as a block filter. This allows using the Filter Set schema to filter blocks ad-hoc without needing to save a Filter Set. See the `FilterSet` resource''s `filter` attribute for the available schema. **Note:** The `filter[filter_set_id]` parameter will override this option if both are provided. ' grandparent_view_id: items: type: string format: uuid description: 'The IDs of grandparent views to which the results should be filter. A "grandparent" view will contain the resulting blocks on one of its sub-plans. For example: If I create View "A", place Block "B" on its timeline, open that block, and add Block "C" to its sub-plan, then I would expect Block "C" to be returned if I provide the `id` of View "A" in this filter. ' has_child_view: type: boolean description: 'When set to "true", only blocks that have a child view will be returned. When set to "false", only blocks that do not have a child view will be returned. Omission of this filter will return all blocks with or without child views. ' has_dates: type: boolean description: 'When set to "true", only blocks with both a `start_at` and a `duration` value will be returned. When set to "false", only blocks which are missing a `start_at` or `duration` value will be returned. ' has_start_at: type: boolean description: 'When set to "true", only blocks with a `start_at` value will be returned (regardless of `duration` value). When set to "false", only blocks without a `start_at` value will be returned. This filter can be used in combination with `has_dates` to provide more granular date-based filtering. ' start_at: type: object properties: gteq: type: string format: date description: Return blocks whose `start_at` is on or after this date. lteq: type: string format: date description: Return blocks whose `start_at` is on or before this date. description: 'Filter by the block''s scheduled `start_at` date. Supports the `gteq` (greater than or equal to) and `lteq` (less than or equal to) operators, e.g. `filter[start_at][lteq]=2026-07-31`, with `YYYY-MM-DD` values. Blocks without a `start_at` are never returned when this filter is set (a null date satisfies no comparison). ' end_at: type: object properties: gteq: type: string format: date description: Return blocks whose active period ends on or after this date. lteq: type: string format: date description: Return blocks whose active period ends on or before this date. description: 'Filter by the block''s derived active-period end date. A block''s active period runs from its `start_at` to its effective end date — `start_at` plus `duration`, or `start_at` for blocks with no `duration`. `end_at` is not a stored attribute; it is computed for comparison purposes. Supports the `gteq` (greater than or equal to) and `lteq` (less than or equal to) operators, e.g. `filter[end_at][gteq]=2026-07-01`, with `YYYY-MM-DD` values. Combine `filter[end_at][gteq]` with `filter[start_at][lteq]` to return only blocks whose active period intersects a window (e.g. "what is happening in July?"). Blocks without a `start_at` are never returned when this filter is set (a null date satisfies no comparison). ' is_nested: type: boolean description: 'When set to "true", only blocks that belong to a view will be returned. When set to "false", only top-level blocks will be returned. Omission of this filter will return both top-level and nested blocks. ' is_template: type: boolean description: 'Boolean `true` returns only blocks that have `is_template` set as `true`, while boolean `false` returns only `block`s that are not templates. Omission will return both templated and non-templated `block`s. ' browsable: type: boolean description: 'Boolean `true` returns only blocks that have `browsable` set as `true`, while boolean `false` returns only `block`s that are not browsable. Omission will return both browsable and non-browsable `block`s. Browsable blocks will show up in directory views (like the Plans directory). ' paired_moment_id: type: array items: type: string format: uuid description: 'The IDs of paired moments to which results should be filtered. Multiple IDs should be comma-separated. Only blocks paired to the specified moments will be returned. ' updated_at: oneOf: - type: string format: date-time - type: object properties: eq: type: string format: date-time gteq: type: string format: date-time lteq: type: string format: date-time description: 'Filter blocks by their `updated_at` timestamp. **Basic form** (defaults to `eq`): - `filter[updated_at]=2024-01-01T00:00:00Z` - Returns blocks updated exactly at this time **With modifiers**: - `filter[updated_at][eq]=2024-01-01T00:00:00Z` - Equal to (same as basic form) - `filter[updated_at][gteq]=2024-01-01T00:00:00Z` - Greater than or equal to - `filter[updated_at][lteq]=2024-01-01T00:00:00Z` - Less than or equal to Multiple modifiers can be combined (e.g., `filter[updated_at][gteq]=...&filter[updated_at][lteq]=...` for range queries). The value must be a valid ISO8601 datetime string (e.g., "2024-01-01T00:00:00Z"). ' view_id: type: array items: type: string format: uuid description: The IDs of the views to which results should be filtered. Multiple IDs should be comma-separated. workspace_id: type: array description: 'The IDs of the workspaces to which results should be filtered. Comma separated list of IDs. If included, will only fetch resources associated with these workspaces. If not included, will return resources associated with all workspaces that the user belongs to. For example, `filter[workspace_id]=798ac6d9-b3fc-4155-88ee-237f43f3404b` will fetch all resources associated with workspace `798ac6d9-b3fc-4155-88ee-237f43f3404b`, while `filter[workspace_id]=798ac6d9-b3fc-4155-88ee-237f43f3404b,d79e513e-9246-454e-80bf-8268bc39cd6e,f2b19a4a-ba0c-49be-8aa7-a1bf68a4a4ed` will fetch any resources associated with workspaces `798ac6d9-b3fc-4155-88ee-237f43f3404b`, `d79e513e-9246-454e-80bf-8268bc39cd6e`, or `f2b19a4a-ba0c-49be-8aa7-a1bf68a4a4ed`. ' items: type: string format: uuid style: deepObject explode: true - name: include in: query required: false description: A comma separated value of related objects to include. schema: type: array items: type: string enum: - asset - block_connectors - block_connectors.category - block_connectors.category.category_type - block_connectors.view - block_connectors.view.categories - block_connectors.view.colors - block_connectors.view.key_dates - block_connectors.view.parent_block - boards - category - category.category_type - child_view - child_view.categories - child_view.colors - child_view.key_dates - custom_field_values - custom_field_values.custom_field - custom_field_values.custom_field.custom_field_type - custom_field_values.groups - custom_field_values.users - inherited_custom_field_values - inherited_custom_field_values.custom_field - inherited_custom_field_values.custom_field.custom_field_type - inherited_custom_field_values.groups - inherited_custom_field_values.users - view - view.categories - view.colors - view.key_dates - view.parent_block - view.parent_block.view style: form explode: false - name: page description: Specify an offset and limit for pagination in: query required: false schema: type: object properties: limit: type: integer default: 50 offset: type: integer style: deepObject explode: true - name: expose in: query required: false description: "Optionally calculated view metadata which are not part of responses by default.\n\nYou request that metadata be included in responses with the `expose` query\nparameter like: `?expose[block][meta]` or more granularly \n`?expose[block][meta][effective_privacy]`.\n" style: deepObject explode: true schema: type: object additionalProperties: false properties: block: type: object additionalProperties: false properties: meta: type: object properties: effective_privacy: type: - string - 'null' description: 'Expose the effective privacy of the block resource. Use this parameter as: `?expose[block][meta][effective_privacy]` ' responses: '200': description: A collection of Blocks. content: application/json: schema: type: object required: - data - meta properties: data: type: array items: title: block type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block meta: type: - object - 'null' description: 'Optionally calculated block metadata which are not part of responses by default. ' additionalProperties: false properties: effective_category_type: type: - object - 'null' description: The Block resource's most immediate ancestor's Category Type. See documentation for Category Type for additional details. additionalProperties: false properties: id: type: string description: The Category Type's ID name: type: string description: The Category Type's display name description: type: - string - 'null' description: Optional additional descriptive text. deactivated_at: type: - string - 'null' format: date-time description: A flag indicating whether the category type is deactivated. effective_privacy: type: string enum: - whole_workspace - some_but_not_all description: 'The effective privacy of a resource is calculated based on all direct and inherited access. If a resource or any of its parents that it inherits access from are accessible to the entire workspace, the effective privacy is `whole_workspace`. Otherwise, the effective privacy is `some_but_not_all`. ' custom_fields: type: array description: "This metadata is available when requesting block resources from the\n`loupe/v3/blocks/{block_id}` `GET` endpoint.\n\nYou request that this metadata be included in responses with the `expose` query \nparameter like: `loupe/v3/blocks/{block_id}?expose[block][meta][custom_fields]`.\n\nEffective custom fields include both **directly assigned** and **inherited** fields from \nthe associated category type. Inherited fields may, or may not, have explicit \n`block_custom_field_value`s.\n\nThe result is a list of effective custom fields for the block. Can be empty or\ncontain multiple instances of any custom field type.\n\nOrdering:\n- Inherited custom fields appear first, ordered by the associated\n Category Type’s saved custom field order.\n- Directly assigned custom fields (via block_custom_field_values)\n follow, preserving their relative order as returned by the service.\n" items: type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - multiSelect - date - url - usersSelect description: The type of custom field. association_type: type: string description: Indicates whether the field is `direct` (explicitly assigned to the block) or `inherited` (comes from the category type). enum: - direct - inherited options: type: array description: Active options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: description: The value for this custom field. Can be null for fields that have no value set. oneOf: - title: Field Value type: object required: - id - value properties: id: type: string format: uuid description: The ID of the custom field value. value: oneOf: - title: Textarea Value type: object required: - value properties: value: type: - string - 'null' description: The text content. - title: Multi Select Value type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select Value type: object required: - id properties: id: type: - string - 'null' format: uuid description: The selected option ID. - title: Date Value type: object required: - value properties: value: type: - string - 'null' format: date-time description: The selected date. - title: URL Value type: object required: - url properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Optional display label for the URL. - title: Users Select Value type: object additionalProperties: false properties: user_ids: type: array description: List of selected user IDs. items: type: string format: uuid group_ids: type: array description: List of selected user group IDs. items: type: string format: uuid - title: 'Null' type: - object - 'null' enum: - null attributes: type: object required: - color - description - duration - title - start_at - row_index - y_scale - browsable - is_template - template_name - template_description - is_workspace_wide_template - created_at - updated_at additionalProperties: false properties: color: type: - string - 'null' description: A color applied to this block. Currently only supports hex values in the format of '#FFF' or '#FFFFFF'. description: type: - string - 'null' description: Text describing the block. Maximum length of 256 characters. title: type: string description: A descriptive name for the block. start_at: type: - string - 'null' description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the beginning of the span of time that this block resource represents. end_at: type: - string - 'null' deprecated: true description: 'DEPRECATED: migrate to `duration`. An ISO 8601-formatted (''YYYY-MM-DD'') date marking the end of the span of time that this block resource respresents. The start_at value must be a date ocurring before the end_at value.' duration: type: - string - 'null' description: 'An ISO 8601 duration string representing the length of time this block spans. Permitted formats: P{n}D (days), P{n}W (weeks), P{n}M (months). When a block has a start_at, the duration is always in days. Week and month units are only used for unscheduled blocks (start_at is null). Clients compute end_at as start_at + duration. ' row_index: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A 1-based value indicating its row position relative to other rows of blocks within their bounding parent, a Category. ' y_scale: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A value indicating how tall the block will be relative to the default size. ' browsable: type: boolean description: 'Whether this block shows up in the Plans Directory (and in the future, other directories). If false, the block is still accessible in the web application via any parent plans or connections or even by way of direct link. It just won''t show up in the Plans Directory. ' default: false created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true is_template: type: boolean readOnly: true description: 'Whether this block is a template that can be used to create new blocks. This field is read-only and cannot be set directly. Templates are created by duplicating an existing block with `is_template=true` via the block duplication endpoint. To remove a block from being a template, use the `delete` endpoint for Blocks. ' default: false is_workspace_wide_template: type: boolean description: 'Whether this template is available workspace-wide. When `true`, the template can be used across all plans in the workspace. When `false`, the template is only available within its origin plan. This field can only be set when `is_template` is `true`.' default: false template_name: type: - string - 'null' description: Display name for the template. Required when `is_template` is `true`. template_description: type: - string - 'null' description: Optional description of the template's purpose. relationships: type: object additionalProperties: false required: - creator - owner - rich_text_document - workspace properties: asset: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset boards: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board block_connectors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector category: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user owner: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user rich_text_document: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - rich_text_document workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace view: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view child_view: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value inherited_custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value paired_moment: allOf: - description: 'Only blocks of a type that supports moment pairing are allowed to have paired moments. Furthermore, this relationship is only writable when first creating a block and cannot be changed thereafter. If a block of a type that supports moment pairing is created without specifying a paired_moment, a new paired_moment is created for that block. **NOTE** that this relationship is currently [PROPOSED], not implemented. ' - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment included: type: array items: oneOf: - title: asset type: object required: - id - type - attributes - links - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset attributes: type: object required: - bytes - created_at - download_url_override - duration - file_extension - file_name - height - mime_type - updated_at - url - width additionalProperties: false properties: url: type: string download_url_override: type: - string - 'null' description: 'An alternative download URL for the file. If set, downloading the asset will result in a redirect to the overridden location instead of downloading the asset data directly. When not present, `url` should be used. ' width: type: - integer - 'null' description: When applicable, the width in pixels of an image or video. height: type: - integer - 'null' description: When applicable, the height in pixels of an image or video. duration: type: - integer - 'null' description: When applicable, the play time of a video in seconds. pages: type: - integer - 'null' description: When applicable, the number of pages in a PDF document. mime_type: type: string description: The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) that corresponds to the uploaded file. file_name: type: string file_extension: type: string bytes: type: integer description: The size of the file in bytes. created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true links: type: object additionalProperties: false required: - v2_request properties: v2_request: type: string format: uri relationships: required: - opal type: object additionalProperties: false properties: opal: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - opal - title: block_connector type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector attributes: type: object required: - row_index - y_scale - created_at - updated_at additionalProperties: false properties: row_index: type: integer description: A 1-based value indicating the connected block's row position relative to other rows of blocks within their bounding parent, a Category. y_scale: type: integer description: A value indicating how tall the block will be relative to the default size specified in the Category. created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - block - view additionalProperties: false properties: block: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view category: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category - title: board type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board attributes: type: object required: - created_at - description - is_public - is_archived - title - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the board. is_public: type: boolean description: 'Indicates whether or not a board and all of its contents are visible to users in the workspace. Unless otherwise specified, this value is `false` by default. Boards are always visible to the user that created them. ' is_archived: type: boolean description: 'Indicates whether or not a board has been archived. If set to `true`, the UI will only display the board in the ‘Archived Boards’ view. If set to `false` (the default), the board may be displayed in other views, depending on the user’s filter settings. ' title: type: string description: The name of the board. updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object additionalProperties: false required: - created_by_user - workspace properties: asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference board_collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_collaborator board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user object_collections: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace board_columns: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_column board_user_setting: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_user_setting default_story: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - story - title: category type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category attributes: type: object required: - title - position - block_size - view_mode - group_by_strategy - group_by_exclude_empty_groupings - depth - is_supportive - created_at - updated_at additionalProperties: false properties: title: type: string description: A descriptive name for the category. depth: type: integer readOnly: true description: This is a read-only calculated field. Given that a category can have a parent category, depth is a zero-based indication of how far removed this category is from the root category. position: type: integer description: A zero-based value indicating its position relative to other categories at the same depth. block_size: type: string description: An enumeration representing the sizes of block resources within the category. enum: - small - medium - large view_mode: type: string description: An enumeration representing the display mode of the category. enum: - default - condensed group_by_strategy: type: - string - 'null' description: 'An enumeration representing the grouping strategy of a category, part of instructions to the client on how children within the category should be displayed. If set to `custom_field`, then the the `group_by_custom_field` relationship must also be provided. ' enum: - null - category_type - custom_field group_by_exclude_empty_groupings: type: boolean default: true description: 'Part of instructions to the client on how children within the category should be displayed. Inidicates whether groupings that are empty should be hidden from view. Defaults to true. ' is_supportive: type: boolean default: false description: 'Indicates that the category contains blocks native to other views, and that the blocks within are here "in support of" this category''s view. Categories with this attribute set to `true` are created internally by the system, and cannot be edited. ' readOnly: true created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true relationships: type: object additionalProperties: false required: - block_connectors - blocks - charts - creator - view properties: block_template: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block block_connectors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector blocks: deprecated: true description: 'Reading blocks directly through the category has been deprecated in favor of reading block_connectors. ' type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type charts: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - chart creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user filter_set: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - filter_set group_by_custom_field: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field parent_category: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view meta: type: object required: - effective_category_type_id properties: effective_category_type_id: type: - string - 'null' format: uuid description: 'The id of the “effective” `category_type` relationship for this `category` resource, as described in [the Categories overview](/api/documentation/v3#tag/Categories).' readOnly: true - title: category_type type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type attributes: type: object required: - created_at - name - supported_paired_type additionalProperties: false properties: name: type: string description: The name that will be displayed in the Opal application UI. description: type: - string - 'null' description: A description of the record. supported_paired_type: type: - string - 'null' default: null enum: - moment - null description: Whether blocks of this type will have resources of the given type paired with them. Moment pairing allows teams to work with the same resources from the Plan (via blocks) or from a Board or Calendar (via Moments). Once set to 'moment', this property cannot be set back to null. Blocks created with a type that supports moment pairing will always have paired moments. Conversely, blocks created with types that do not support moment pairing will not have paired moments (unless moment pairing support is added to the type later). created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true deactivated_at: type: - string - 'null' format: date-time description: An RFC 3339 date-time. If present, indicates the record has been deactivated (but not deleted). has_explicit_custom_field_order: type: boolean default: false description: 'If true, the category type uses its own saved order for `custom_fields`. If false, ordering falls back to the global custom field order (e.g., `custom_fields.created_at`). ' relationships: type: object required: - creator - workspace - in_support_of_category_types additionalProperties: false properties: creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace custom_fields: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field default_child_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type in_support_of_category_types: description: 'A list of category_types that this type is configured to support. ' type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type - title: key_date type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - key_date attributes: type: object required: - title - color - start_date - end_date - created_at - updated_at additionalProperties: false properties: title: type: string description: A descriptive name for the key event or date. color: type: - string - 'null' description: A color for this key date. The value must be in hex format, such as '#FFF' or '#FFFFFF'. start_date: type: string description: The start of the period, represented as an ISO 8601-formatted ('YYYY-MM-DD') date, when this key event or date begins to be observed. A single-day event can be represented with a start_date and a null end_date. end_date: type: - string - 'null' description: The end of the period, represented as an ISO 8601-formatted ('YYYY-MM-DD') date, when this key event or date ceases to be observed. created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true relationships: type: object additionalProperties: false required: - view properties: view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view - title: view type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view meta: type: - object - 'null' description: 'Optionally calculated view metadata which are not part of responses by default. ' additionalProperties: false properties: effective_privacy: type: string enum: - whole_workspace - some_but_not_all description: 'The effective privacy of a resource is calculated based on all direct and inherited access. If a resource or any of its parents that it inherits access from are accessible to the entire workspace, the effective privacy is `whole_workspace`. Otherwise, the effective privacy is `some_but_not_all`. ' attributes: type: object required: - title - kind - start_at - end_at - description - default_timescale - created_at - updated_at - start_month_index - start_weekday_index - show_smart_swimlane_datasource - swimlane_title_column_width additionalProperties: false properties: title: type: string description: A descriptive name for the view. description: type: - string - 'null' description: A field allowing for additional descriptive text. kind: type: string description: An enumeration representing the view type. Currently only supports Plan views. enum: - plan default_timescale: type: string description: An enumeration representing the timescale of this view. enum: - day - week - month - quarter start_at: type: string description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the beginning of the span of time that this view resource respresents. The start_at value must be a date ocurring before the end_at value. end_at: type: string description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the end of the span of time that this view resource respresents. The start_at value must be a date ocurring before the end_at value. created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true start_month_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 description: Start month index for the plan. Specifies the number of months, 0 to 11, to offset from January. 0 by default, meaning no offset. If set, e.g., 1, start in February. start_weekday_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 description: Start weekday index for the plan. Specifies the days in a week, 0 to 6 (Sunday to Saturday). 0 (Sunday) is the default. If set to, e.g., 1, weeks will start on Monday. show_smart_swimlane_datasource: type: boolean description: Whether to display the datasource filter information on smart swimlanes. Defaults to true. swimlane_title_column_width: type: integer description: The width in pixels of the swimlane title column from 200 to 800 for persistence across sessions. Defaults to 200. relationships: type: object additionalProperties: false required: - categories - blocks - owner - creator - workspace - colors - key_dates - parent_block properties: categories: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type blocks: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block owner: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace colors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view_color key_dates: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - key_date parent_block: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block - title: view_color type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view_color attributes: type: object required: - label - color - created_at - updated_at additionalProperties: false properties: label: type: - string - 'null' description: A descriptive name for the color. color: type: string description: A color in hex format. Currently only supports hex values in the format of '#FFF' or '#FFFFFF'. created_at: type: string readOnly: true format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. updated_at: type: string readOnly: true format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. relationships: type: object additionalProperties: false required: - view properties: view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view - type: object required: - data properties: data: title: block type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block meta: type: - object - 'null' description: 'Optionally calculated block metadata which are not part of responses by default. ' additionalProperties: false properties: effective_category_type: type: - object - 'null' description: The Block resource's most immediate ancestor's Category Type. See documentation for Category Type for additional details. additionalProperties: false properties: id: type: string description: The Category Type's ID name: type: string description: The Category Type's display name description: type: - string - 'null' description: Optional additional descriptive text. deactivated_at: type: - string - 'null' format: date-time description: A flag indicating whether the category type is deactivated. effective_privacy: type: string enum: - whole_workspace - some_but_not_all description: 'The effective privacy of a resource is calculated based on all direct and inherited access. If a resource or any of its parents that it inherits access from are accessible to the entire workspace, the effective privacy is `whole_workspace`. Otherwise, the effective privacy is `some_but_not_all`. ' custom_fields: type: array description: "This metadata is available when requesting block resources from the\n`loupe/v3/blocks/{block_id}` `GET` endpoint.\n\nYou request that this metadata be included in responses with the `expose` query \nparameter like: `loupe/v3/blocks/{block_id}?expose[block][meta][custom_fields]`.\n\nEffective custom fields include both **directly assigned** and **inherited** fields from \nthe associated category type. Inherited fields may, or may not, have explicit \n`block_custom_field_value`s.\n\nThe result is a list of effective custom fields for the block. Can be empty or\ncontain multiple instances of any custom field type.\n\nOrdering:\n- Inherited custom fields appear first, ordered by the associated\n Category Type’s saved custom field order.\n- Directly assigned custom fields (via block_custom_field_values)\n follow, preserving their relative order as returned by the service.\n" items: type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - multiSelect - date - url - usersSelect description: The type of custom field. association_type: type: string description: Indicates whether the field is `direct` (explicitly assigned to the block) or `inherited` (comes from the category type). enum: - direct - inherited options: type: array description: Active options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: description: The value for this custom field. Can be null for fields that have no value set. oneOf: - title: Field Value type: object required: - id - value properties: id: type: string format: uuid description: The ID of the custom field value. value: oneOf: - title: Textarea Value type: object required: - value properties: value: type: - string - 'null' description: The text content. - title: Multi Select Value type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select Value type: object required: - id properties: id: type: - string - 'null' format: uuid description: The selected option ID. - title: Date Value type: object required: - value properties: value: type: - string - 'null' format: date-time description: The selected date. - title: URL Value type: object required: - url properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Optional display label for the URL. - title: Users Select Value type: object additionalProperties: false properties: user_ids: type: array description: List of selected user IDs. items: type: string format: uuid group_ids: type: array description: List of selected user group IDs. items: type: string format: uuid - title: 'Null' type: - object - 'null' enum: - null attributes: type: object required: - color - description - duration - title - start_at - row_index - y_scale - browsable - is_template - template_name - template_description - is_workspace_wide_template - created_at - updated_at additionalProperties: false properties: color: type: - string - 'null' description: A color applied to this block. Currently only supports hex values in the format of '#FFF' or '#FFFFFF'. description: type: - string - 'null' description: Text describing the block. Maximum length of 256 characters. title: type: string description: A descriptive name for the block. start_at: type: - string - 'null' description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the beginning of the span of time that this block resource represents. end_at: type: - string - 'null' deprecated: true description: 'DEPRECATED: migrate to `duration`. An ISO 8601-formatted (''YYYY-MM-DD'') date marking the end of the span of time that this block resource respresents. The start_at value must be a date ocurring before the end_at value.' duration: type: - string - 'null' description: 'An ISO 8601 duration string representing the length of time this block spans. Permitted formats: P{n}D (days), P{n}W (weeks), P{n}M (months). When a block has a start_at, the duration is always in days. Week and month units are only used for unscheduled blocks (start_at is null). Clients compute end_at as start_at + duration. ' row_index: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A 1-based value indicating its row position relative to other rows of blocks within their bounding parent, a Category. ' y_scale: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A value indicating how tall the block will be relative to the default size. ' browsable: type: boolean description: 'Whether this block shows up in the Plans Directory (and in the future, other directories). If false, the block is still accessible in the web application via any parent plans or connections or even by way of direct link. It just won''t show up in the Plans Directory. ' default: false created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true is_template: type: boolean readOnly: true description: 'Whether this block is a template that can be used to create new blocks. This field is read-only and cannot be set directly. Templates are created by duplicating an existing block with `is_template=true` via the block duplication endpoint. To remove a block from being a template, use the `delete` endpoint for Blocks. ' default: false is_workspace_wide_template: type: boolean description: 'Whether this template is available workspace-wide. When `true`, the template can be used across all plans in the workspace. When `false`, the template is only available within its origin plan. This field can only be set when `is_template` is `true`.' default: false template_name: type: - string - 'null' description: Display name for the template. Required when `is_template` is `true`. template_description: type: - string - 'null' description: Optional description of the template's purpose. relationships: type: object additionalProperties: false required: - creator - owner - rich_text_document - workspace properties: asset: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset boards: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board block_connectors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector category: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user owner: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user rich_text_document: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - rich_text_document workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace view: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view child_view: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value inherited_custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value paired_moment: allOf: - description: 'Only blocks of a type that supports moment pairing are allowed to have paired moments. Furthermore, this relationship is only writable when first creating a block and cannot be changed thereafter. If a block of a type that supports moment pairing is created without specifying a paired_moment, a new paired_moment is created for that block. **NOTE** that this relationship is currently [PROPOSED], not implemented. ' - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment meta: type: object properties: access: type: object description: 'Information about who has access to the given resource. This metadata is only available for single (non-batch) `GET` / `PATCH` / `POST` requests, and is not returned by default. Add `expose[meta][access]` to your query parameters to request it in the response body. ' additionalProperties: false required: - users - groups - resources properties: users: type: array description: 'A list of users that have access to this resource. These users have been given direct access; the list does not include all users who have access via a User Group or inherited resource. Each item in the list is a JSON:API Resource Identifier Object. All entries are `user`s. ' items: type: object additionalProperties: false required: - id - type properties: id: type: string format: uuid type: type: string enum: - user groups: type: array description: 'A list of groups that have access to this resource. These are all User Groups that have been created by an admin of the Opal ahead of time. Each item in the list is a JSON:API Resource Identifier Object. All entries are `user_group`s. Each user group''s name is surfaced as `meta.title` for convenience and each user group''s membership count (including all inherited membership) is surfaced as `meta.count`. ' items: type: object additionalProperties: false required: - id - type - meta properties: id: type: string format: uuid type: type: string enum: - user_group meta: type: object readOnly: true additionalProperties: false required: - title - count properties: title: type: string readOnly: true count: type: integer minimum: 0 readOnly: true resources: type: array description: 'A list of resources from which this resource _might_ inherit membership. The list always contains an entry for every other resource allowed to provide membership to the given resource. Look at the `meta.inherits_membership` property to determine if a given resource''s membership actually is being inherited. Each item in the list is a JSON:API Resource Identifier Object. Entries may have varying `types` but all resources can be retrieved separately from Opal API endpoints to get more information about them. Each resource''s name or title is surfaced as `meta.title` for convenience and each resource''s membership count (including all inherited membership) is surfaced as `meta.count`. ' items: type: object additionalProperties: false required: - id - type - meta properties: id: type: string format: uuid type: type: string meta: type: object additionalProperties: false required: - inherits_membership - title - count properties: inherits_membership: type: boolean title: type: string readOnly: true count: type: integer minimum: 0 readOnly: true included: type: array items: oneOf: - title: asset type: object required: - id - type - attributes - links - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset attributes: type: object required: - bytes - created_at - download_url_override - duration - file_extension - file_name - height - mime_type - updated_at - url - width additionalProperties: false properties: url: type: string download_url_override: type: - string - 'null' description: 'An alternative download URL for the file. If set, downloading the asset will result in a redirect to the overridden location instead of downloading the asset data directly. When not present, `url` should be used. ' width: type: - integer - 'null' description: When applicable, the width in pixels of an image or video. height: type: - integer - 'null' description: When applicable, the height in pixels of an image or video. duration: type: - integer - 'null' description: When applicable, the play time of a video in seconds. pages: type: - integer - 'null' description: When applicable, the number of pages in a PDF document. mime_type: type: string description: The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) that corresponds to the uploaded file. file_name: type: string file_extension: type: string bytes: type: integer description: The size of the file in bytes. created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true links: type: object additionalProperties: false required: - v2_request properties: v2_request: type: string format: uri relationships: required: - opal type: object additionalProperties: false properties: opal: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - opal - title: block type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block meta: type: - object - 'null' description: 'Optionally calculated block metadata which are not part of responses by default. ' additionalProperties: false properties: effective_category_type: type: - object - 'null' description: The Block resource's most immediate ancestor's Category Type. See documentation for Category Type for additional details. additionalProperties: false properties: id: type: string description: The Category Type's ID name: type: string description: The Category Type's display name description: type: - string - 'null' description: Optional additional descriptive text. deactivated_at: type: - string - 'null' format: date-time description: A flag indicating whether the category type is deactivated. effective_privacy: type: string enum: - whole_workspace - some_but_not_all description: 'The effective privacy of a resource is calculated based on all direct and inherited access. If a resource or any of its parents that it inherits access from are accessible to the entire workspace, the effective privacy is `whole_workspace`. Otherwise, the effective privacy is `some_but_not_all`. ' custom_fields: type: array description: "This metadata is available when requesting block resources from the\n`loupe/v3/blocks/{block_id}` `GET` endpoint.\n\nYou request that this metadata be included in responses with the `expose` query \nparameter like: `loupe/v3/blocks/{block_id}?expose[block][meta][custom_fields]`.\n\nEffective custom fields include both **directly assigned** and **inherited** fields from \nthe associated category type. Inherited fields may, or may not, have explicit \n`block_custom_field_value`s.\n\nThe result is a list of effective custom fields for the block. Can be empty or\ncontain multiple instances of any custom field type.\n\nOrdering:\n- Inherited custom fields appear first, ordered by the associated\n Category Type’s saved custom field order.\n- Directly assigned custom fields (via block_custom_field_values)\n follow, preserving their relative order as returned by the service.\n" items: type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - multiSelect - date - url - usersSelect description: The type of custom field. association_type: type: string description: Indicates whether the field is `direct` (explicitly assigned to the block) or `inherited` (comes from the category type). enum: - direct - inherited options: type: array description: Active options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: description: The value for this custom field. Can be null for fields that have no value set. oneOf: - title: Field Value type: object required: - id - value properties: id: type: string format: uuid description: The ID of the custom field value. value: oneOf: - title: Textarea Value type: object required: - value properties: value: type: - string - 'null' description: The text content. - title: Multi Select Value type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select Value type: object required: - id properties: id: type: - string - 'null' format: uuid description: The selected option ID. - title: Date Value type: object required: - value properties: value: type: - string - 'null' format: date-time description: The selected date. - title: URL Value type: object required: - url properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Optional display label for the URL. - title: Users Select Value type: object additionalProperties: false properties: user_ids: type: array description: List of selected user IDs. items: type: string format: uuid group_ids: type: array description: List of selected user group IDs. items: type: string format: uuid - title: 'Null' type: - object - 'null' enum: - null attributes: type: object required: - color - description - duration - title - start_at - row_index - y_scale - browsable - is_template - template_name - template_description - is_workspace_wide_template - created_at - updated_at additionalProperties: false properties: color: type: - string - 'null' description: A color applied to this block. Currently only supports hex values in the format of '#FFF' or '#FFFFFF'. description: type: - string - 'null' description: Text describing the block. Maximum length of 256 characters. title: type: string description: A descriptive name for the block. start_at: type: - string - 'null' description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the beginning of the span of time that this block resource represents. end_at: type: - string - 'null' deprecated: true description: 'DEPRECATED: migrate to `duration`. An ISO 8601-formatted (''YYYY-MM-DD'') date marking the end of the span of time that this block resource respresents. The start_at value must be a date ocurring before the end_at value.' duration: type: - string - 'null' description: 'An ISO 8601 duration string representing the length of time this block spans. Permitted formats: P{n}D (days), P{n}W (weeks), P{n}M (months). When a block has a start_at, the duration is always in days. Week and month units are only used for unscheduled blocks (start_at is null). Clients compute end_at as start_at + duration. ' row_index: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A 1-based value indicating its row position relative to other rows of blocks within their bounding parent, a Category. ' y_scale: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A value indicating how tall the block will be relative to the default size. ' browsable: type: boolean description: 'Whether this block shows up in the Plans Directory (and in the future, other directories). If false, the block is still accessible in the web application via any parent plans or connections or even by way of direct link. It just won''t show up in the Plans Directory. ' default: false created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true is_template: type: boolean readOnly: true description: 'Whether this block is a template that can be used to create new blocks. This field is read-only and cannot be set directly. Templates are created by duplicating an existing block with `is_template=true` via the block duplication endpoint. To remove a block from being a template, use the `delete` endpoint for Blocks. ' default: false is_workspace_wide_template: type: boolean description: 'Whether this template is available workspace-wide. When `true`, the template can be used across all plans in the workspace. When `false`, the template is only available within its origin plan. This field can only be set when `is_template` is `true`.' default: false template_name: type: - string - 'null' description: Display name for the template. Required when `is_template` is `true`. template_description: type: - string - 'null' description: Optional description of the template's purpose. relationships: type: object additionalProperties: false required: - creator - owner - rich_text_document - workspace properties: asset: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset boards: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board block_connectors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector category: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user owner: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user rich_text_document: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - rich_text_document workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace view: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view child_view: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value inherited_custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value paired_moment: allOf: - description: 'Only blocks of a type that supports moment pairing are allowed to have paired moments. Furthermore, this relationship is only writable when first creating a block and cannot be changed thereafter. If a block of a type that supports moment pairing is created without specifying a paired_moment, a new paired_moment is created for that block. **NOTE** that this relationship is currently [PROPOSED], not implemented. ' - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment - title: block_connector type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector attributes: type: object required: - row_index - y_scale - created_at - updated_at additionalProperties: false properties: row_index: type: integer description: A 1-based value indicating the connected block's row position relative to other rows of blocks within their bounding parent, a Category. y_scale: type: integer description: A value indicating how tall the block will be relative to the default size specified in the Category. created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - block - view additionalProperties: false properties: block: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view category: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category - title: board type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board attributes: type: object required: - created_at - description - is_public - is_archived - title - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the board. is_public: type: boolean description: 'Indicates whether or not a board and all of its contents are visible to users in the workspace. Unless otherwise specified, this value is `false` by default. Boards are always visible to the user that created them. ' is_archived: type: boolean description: 'Indicates whether or not a board has been archived. If set to `true`, the UI will only display the board in the ‘Archived Boards’ view. If set to `false` (the default), the board may be displayed in other views, depending on the user’s filter settings. ' title: type: string description: The name of the board. updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object additionalProperties: false required: - created_by_user - workspace properties: asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference board_collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_collaborator board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user object_collections: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace board_columns: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_column board_user_setting: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_user_setting default_story: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - story - title: category type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category attributes: type: object required: - title - position - block_size - view_mode - group_by_strategy - group_by_exclude_empty_groupings - depth - is_supportive - created_at - updated_at additionalProperties: false properties: title: type: string description: A descriptive name for the category. depth: type: integer readOnly: true description: This is a read-only calculated field. Given that a category can have a parent category, depth is a zero-based indication of how far removed this category is from the root category. position: type: integer description: A zero-based value indicating its position relative to other categories at the same depth. block_size: type: string description: An enumeration representing the sizes of block resources within the category. enum: - small - medium - large view_mode: type: string description: An enumeration representing the display mode of the category. enum: - default - condensed group_by_strategy: type: - string - 'null' description: 'An enumeration representing the grouping strategy of a category, part of instructions to the client on how children within the category should be displayed. If set to `custom_field`, then the the `group_by_custom_field` relationship must also be provided. ' enum: - null - category_type - custom_field group_by_exclude_empty_groupings: type: boolean default: true description: 'Part of instructions to the client on how children within the category should be displayed. Inidicates whether groupings that are empty should be hidden from view. Defaults to true. ' is_supportive: type: boolean default: false description: 'Indicates that the category contains blocks native to other views, and that the blocks within are here "in support of" this category''s view. Categories with this attribute set to `true` are created internally by the system, and cannot be edited. ' readOnly: true created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true relationships: type: object additionalProperties: false required: - block_connectors - blocks - charts - creator - view properties: block_template: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block block_connectors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector blocks: deprecated: true description: 'Reading blocks directly through the category has been deprecated in favor of reading block_connectors. ' type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type charts: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - chart creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user filter_set: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - filter_set group_by_custom_field: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field parent_category: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view meta: type: object required: - effective_category_type_id properties: effective_category_type_id: type: - string - 'null' format: uuid description: 'The id of the “effective” `category_type` relationship for this `category` resource, as described in [the Categories overview](/api/documentation/v3#tag/Categories).' readOnly: true - title: category_type type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type attributes: type: object required: - created_at - name - supported_paired_type additionalProperties: false properties: name: type: string description: The name that will be displayed in the Opal application UI. description: type: - string - 'null' description: A description of the record. supported_paired_type: type: - string - 'null' default: null enum: - moment - null description: Whether blocks of this type will have resources of the given type paired with them. Moment pairing allows teams to work with the same resources from the Plan (via blocks) or from a Board or Calendar (via Moments). Once set to 'moment', this property cannot be set back to null. Blocks created with a type that supports moment pairing will always have paired moments. Conversely, blocks created with types that do not support moment pairing will not have paired moments (unless moment pairing support is added to the type later). created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true deactivated_at: type: - string - 'null' format: date-time description: An RFC 3339 date-time. If present, indicates the record has been deactivated (but not deleted). has_explicit_custom_field_order: type: boolean default: false description: 'If true, the category type uses its own saved order for `custom_fields`. If false, ordering falls back to the global custom field order (e.g., `custom_fields.created_at`). ' relationships: type: object required: - creator - workspace - in_support_of_category_types additionalProperties: false properties: creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace custom_fields: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field default_child_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type in_support_of_category_types: description: 'A list of category_types that this type is configured to support. ' type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type - title: key_date type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - key_date attributes: type: object required: - title - color - start_date - end_date - created_at - updated_at additionalProperties: false properties: title: type: string description: A descriptive name for the key event or date. color: type: - string - 'null' description: A color for this key date. The value must be in hex format, such as '#FFF' or '#FFFFFF'. start_date: type: string description: The start of the period, represented as an ISO 8601-formatted ('YYYY-MM-DD') date, when this key event or date begins to be observed. A single-day event can be represented with a start_date and a null end_date. end_date: type: - string - 'null' description: The end of the period, represented as an ISO 8601-formatted ('YYYY-MM-DD') date, when this key event or date ceases to be observed. created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true relationships: type: object additionalProperties: false required: - view properties: view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view - title: view type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view meta: type: - object - 'null' description: 'Optionally calculated view metadata which are not part of responses by default. ' additionalProperties: false properties: effective_privacy: type: string enum: - whole_workspace - some_but_not_all description: 'The effective privacy of a resource is calculated based on all direct and inherited access. If a resource or any of its parents that it inherits access from are accessible to the entire workspace, the effective privacy is `whole_workspace`. Otherwise, the effective privacy is `some_but_not_all`. ' attributes: type: object required: - title - kind - start_at - end_at - description - default_timescale - created_at - updated_at - start_month_index - start_weekday_index - show_smart_swimlane_datasource - swimlane_title_column_width additionalProperties: false properties: title: type: string description: A descriptive name for the view. description: type: - string - 'null' description: A field allowing for additional descriptive text. kind: type: string description: An enumeration representing the view type. Currently only supports Plan views. enum: - plan default_timescale: type: string description: An enumeration representing the timescale of this view. enum: - day - week - month - quarter start_at: type: string description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the beginning of the span of time that this view resource respresents. The start_at value must be a date ocurring before the end_at value. end_at: type: string description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the end of the span of time that this view resource respresents. The start_at value must be a date ocurring before the end_at value. created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true start_month_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 description: Start month index for the plan. Specifies the number of months, 0 to 11, to offset from January. 0 by default, meaning no offset. If set, e.g., 1, start in February. start_weekday_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 description: Start weekday index for the plan. Specifies the days in a week, 0 to 6 (Sunday to Saturday). 0 (Sunday) is the default. If set to, e.g., 1, weeks will start on Monday. show_smart_swimlane_datasource: type: boolean description: Whether to display the datasource filter information on smart swimlanes. Defaults to true. swimlane_title_column_width: type: integer description: The width in pixels of the swimlane title column from 200 to 800 for persistence across sessions. Defaults to 200. relationships: type: object additionalProperties: false required: - categories - blocks - owner - creator - workspace - colors - key_dates - parent_block properties: categories: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type blocks: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block owner: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace colors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view_color key_dates: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - key_date parent_block: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block - title: view_color type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view_color attributes: type: object required: - label - color - created_at - updated_at additionalProperties: false properties: label: type: - string - 'null' description: A descriptive name for the color. color: type: string description: A color in hex format. Currently only supports hex values in the format of '#FFF' or '#FFFFFF'. created_at: type: string readOnly: true format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. updated_at: type: string readOnly: true format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. relationships: type: object additionalProperties: false required: - view properties: view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view meta: type: object required: - total - page - resource_type properties: resource_type: type: string total: type: integer page: type: object required: - limit - offset properties: limit: type: integer offset: type: integer example: data: - id: f649cebe-3dce-441a-8335-86707303c388 type: block attributes: color: null description: Just kidding, it's always time for coffee. title: Time For Coffee start_at: '2024-01-01' end_at: '2024-12-31' duration: P364D row_index: 1 y_scale: 1 is_template: false is_workspace_wide_template: false browsable: false template_name: null template_description: null created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' relationships: workspace: data: id: a897cb4c-12d3-446f-9621-ff388650d43a type: workspace view: data: id: c3f80757-c0ea-422c-aa51-3c9ef8e11a76 type: view category: data: id: 24b4dd04-e56a-4794-95fa-ea0a0709b5a6 type: category rich_text_document: data: id: 0f8d6b6f-0b32-404d-9d81-7864c3969ac0 type: rich_text_document asset: data: id: 48517d52-3a25-4ca6-a7f5-55a3817fc00f type: asset block_connectors: data: - id: 4cda51c0-3d53-44fe-8bd5-0b294ed1fe78 type: block_connector boards: data: - id: d19806fe-55b3-4682-9d67-07343fea3975 type: board creator: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user owner: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user child_view: data: id: e01b9a23-01f4-447d-96fd-03188fc9edd1 type: view custom_field_values: data: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 type: block_custom_field_value - id: b2c3d4e5-f6g7-8901-bcde-f23456789012 type: block_custom_field_value inherited_custom_field_values: data: - id: f597cbaa-c10c-4538-8bcf-6c2dadacb727 type: block_custom_field_value meta: total: 1 page: limit: 25 offset: 0 resource_type: block '400': description: Bad request content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '401': description: Unauthorized content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '403': description: Forbidden content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status post: tags: - Blocks operationId: CreateBlockV3 x-Operation-ID: CreateBlockV3 summary: Create a new Block description: 'As noted in the overview for the Blocks API, you can pair a block with a moment on creation as long as the type specified for the block supports pairing with moments. If you create a moment-paired block and do not give it an `asset`, it will borrow the moment''s asset. ' security: - oauth2: - offline_access - api_key: [] parameters: - name: include in: query required: false description: A comma separated value of related objects to include. schema: type: array items: type: string enum: - asset - block_connectors - block_connectors.category - block_connectors.category.category_type - block_connectors.view - block_connectors.view.categories - block_connectors.view.colors - block_connectors.view.key_dates - block_connectors.view.parent_block - boards - category - category.category_type - child_view - child_view.categories - child_view.colors - child_view.key_dates - custom_field_values - custom_field_values.custom_field - custom_field_values.custom_field.custom_field_type - custom_field_values.groups - custom_field_values.users - inherited_custom_field_values - inherited_custom_field_values.custom_field - inherited_custom_field_values.custom_field.custom_field_type - inherited_custom_field_values.groups - inherited_custom_field_values.users - view - view.categories - view.colors - view.key_dates - view.parent_block - view.parent_block.view style: form explode: false - name: expose description: Ask for Access metadata to be returned. in: query required: false schema: type: object properties: meta: type: object properties: access: type: - string - 'null' description: 'Information about who has access to the given resource. This metadata is only available for single (non-batch) `GET` / `PATCH` / `POST` requests, and is not returned by default. Add `expose[meta][access]` to your query parameters to request it in the response body. ' style: deepObject explode: true requestBody: content: application/json: schema: type: object required: - data properties: data: type: object required: - type - attributes - relationships properties: type: type: string enum: - block attributes: type: object required: - title properties: color: type: - string - 'null' description: A color applied to this block. Currently only supports hex values in the format of '#FFF' or '#FFFFFF'. description: type: - string - 'null' description: Text describing the block. Maximum length of 256 characters. title: type: string description: A descriptive name for the block. start_at: type: - string - 'null' format: date description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the beginning of the span of time that this block resource respresents. The start_at value must be a date ocurring before the end_at value. duration: type: - string - 'null' description: 'An ISO 8601 duration string: P{n}D (days), P{n}W (weeks), or P{n}M (months). Week and month units are auto-normalized to days when `start_at` is provided. ' row_index: type: integer description: A 1-based value indicating its row position relative to other rows of blocks within their bounding parent, a Category. y_scale: type: integer description: A value indicating how tall the block will be relative to the default size. browsable: type: boolean description: 'Whether this block shows up in the Plans Directory (and in the future, other directories). If false, the block is still accessible in the web application via any parent plans or connections or even by way of direct link. It just won''t show up in the Plans Directory. ' default: false is_template: type: boolean description: 'Whether this block is a template that can be used to create new blocks. Currently, templated Blocks cannot be created from paired Blocks. ' default: false is_workspace_wide_template: type: boolean description: 'Whether this template is available workspace-wide. When `true`, the template can be used across all plans in the workspace. When `false`, the template is only available within its origin plan. This field can only be set when `is_template` is `true`.' default: false template_name: type: - string - 'null' description: Display name for the template. Required when `is_template` is `true`. template_description: type: - string - 'null' description: Optional description of the template's purpose. relationships: type: object required: - owner - workspace properties: workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace view: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view asset: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset boards: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board category: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type owner: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user paired_moment: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment meta: type: object properties: access: type: object description: 'Information about who has access to the given resource. This metadata is only available for single (non-batch) `GET` / `PATCH` / `POST` requests, and is not returned by default. Add `expose[meta][access]` to your query parameters to request it in the response body. ' additionalProperties: false properties: users: type: array description: 'A list of users that have access to this resource. These users have been given direct access; the list does not include all users who have access via a User Group or inherited resource. Each item in the list is a JSON:API Resource Identifier Object. All entries are `user`s. ' items: type: object additionalProperties: false required: - id - type properties: id: type: string format: uuid type: type: string enum: - user groups: type: array description: 'A list of groups that have access to this resource. These are all User Groups that have been created by an admin of the Opal ahead of time. Each item in the list is a JSON:API Resource Identifier Object. All entries are `user_group`s. ' items: type: object additionalProperties: false required: - id - type properties: id: type: string format: uuid type: type: string enum: - user_group resources: type: array description: 'A list of resources from which this resource _might_ inherit membership. The list always contains an entry for every other resource allowed to provide membership to the given resource. Set the `meta.inherits_membership` property to determine if a given resource''s membership actually is being inherited. Each item in the list is a JSON:API Resource Identifier Object. Entries may have varying `types`. ' items: type: object additionalProperties: false required: - id - type - meta properties: id: type: string format: uuid type: type: string meta: type: object additionalProperties: false required: - inherits_membership properties: inherits_membership: type: boolean responses: '201': description: A newly created block resource. content: application/json: schema: type: object required: - data properties: data: title: block type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block meta: type: - object - 'null' description: 'Optionally calculated block metadata which are not part of responses by default. ' additionalProperties: false properties: effective_category_type: type: - object - 'null' description: The Block resource's most immediate ancestor's Category Type. See documentation for Category Type for additional details. additionalProperties: false properties: id: type: string description: The Category Type's ID name: type: string description: The Category Type's display name description: type: - string - 'null' description: Optional additional descriptive text. deactivated_at: type: - string - 'null' format: date-time description: A flag indicating whether the category type is deactivated. effective_privacy: type: string enum: - whole_workspace - some_but_not_all description: 'The effective privacy of a resource is calculated based on all direct and inherited access. If a resource or any of its parents that it inherits access from are accessible to the entire workspace, the effective privacy is `whole_workspace`. Otherwise, the effective privacy is `some_but_not_all`. ' custom_fields: type: array description: "This metadata is available when requesting block resources from the\n`loupe/v3/blocks/{block_id}` `GET` endpoint.\n\nYou request that this metadata be included in responses with the `expose` query \nparameter like: `loupe/v3/blocks/{block_id}?expose[block][meta][custom_fields]`.\n\nEffective custom fields include both **directly assigned** and **inherited** fields from \nthe associated category type. Inherited fields may, or may not, have explicit \n`block_custom_field_value`s.\n\nThe result is a list of effective custom fields for the block. Can be empty or\ncontain multiple instances of any custom field type.\n\nOrdering:\n- Inherited custom fields appear first, ordered by the associated\n Category Type’s saved custom field order.\n- Directly assigned custom fields (via block_custom_field_values)\n follow, preserving their relative order as returned by the service.\n" items: type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - multiSelect - date - url - usersSelect description: The type of custom field. association_type: type: string description: Indicates whether the field is `direct` (explicitly assigned to the block) or `inherited` (comes from the category type). enum: - direct - inherited options: type: array description: Active options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: description: The value for this custom field. Can be null for fields that have no value set. oneOf: - title: Field Value type: object required: - id - value properties: id: type: string format: uuid description: The ID of the custom field value. value: oneOf: - title: Textarea Value type: object required: - value properties: value: type: - string - 'null' description: The text content. - title: Multi Select Value type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select Value type: object required: - id properties: id: type: - string - 'null' format: uuid description: The selected option ID. - title: Date Value type: object required: - value properties: value: type: - string - 'null' format: date-time description: The selected date. - title: URL Value type: object required: - url properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Optional display label for the URL. - title: Users Select Value type: object additionalProperties: false properties: user_ids: type: array description: List of selected user IDs. items: type: string format: uuid group_ids: type: array description: List of selected user group IDs. items: type: string format: uuid - title: 'Null' type: - object - 'null' enum: - null attributes: type: object required: - color - description - duration - title - start_at - row_index - y_scale - browsable - is_template - template_name - template_description - is_workspace_wide_template - created_at - updated_at additionalProperties: false properties: color: type: - string - 'null' description: A color applied to this block. Currently only supports hex values in the format of '#FFF' or '#FFFFFF'. description: type: - string - 'null' description: Text describing the block. Maximum length of 256 characters. title: type: string description: A descriptive name for the block. start_at: type: - string - 'null' description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the beginning of the span of time that this block resource represents. end_at: type: - string - 'null' deprecated: true description: 'DEPRECATED: migrate to `duration`. An ISO 8601-formatted (''YYYY-MM-DD'') date marking the end of the span of time that this block resource respresents. The start_at value must be a date ocurring before the end_at value.' duration: type: - string - 'null' description: 'An ISO 8601 duration string representing the length of time this block spans. Permitted formats: P{n}D (days), P{n}W (weeks), P{n}M (months). When a block has a start_at, the duration is always in days. Week and month units are only used for unscheduled blocks (start_at is null). Clients compute end_at as start_at + duration. ' row_index: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A 1-based value indicating its row position relative to other rows of blocks within their bounding parent, a Category. ' y_scale: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A value indicating how tall the block will be relative to the default size. ' browsable: type: boolean description: 'Whether this block shows up in the Plans Directory (and in the future, other directories). If false, the block is still accessible in the web application via any parent plans or connections or even by way of direct link. It just won''t show up in the Plans Directory. ' default: false created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true is_template: type: boolean readOnly: true description: 'Whether this block is a template that can be used to create new blocks. This field is read-only and cannot be set directly. Templates are created by duplicating an existing block with `is_template=true` via the block duplication endpoint. To remove a block from being a template, use the `delete` endpoint for Blocks. ' default: false is_workspace_wide_template: type: boolean description: 'Whether this template is available workspace-wide. When `true`, the template can be used across all plans in the workspace. When `false`, the template is only available within its origin plan. This field can only be set when `is_template` is `true`.' default: false template_name: type: - string - 'null' description: Display name for the template. Required when `is_template` is `true`. template_description: type: - string - 'null' description: Optional description of the template's purpose. relationships: type: object additionalProperties: false required: - creator - owner - rich_text_document - workspace properties: asset: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset boards: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board block_connectors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector category: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user owner: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user rich_text_document: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - rich_text_document workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace view: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view child_view: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value inherited_custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value paired_moment: allOf: - description: 'Only blocks of a type that supports moment pairing are allowed to have paired moments. Furthermore, this relationship is only writable when first creating a block and cannot be changed thereafter. If a block of a type that supports moment pairing is created without specifying a paired_moment, a new paired_moment is created for that block. **NOTE** that this relationship is currently [PROPOSED], not implemented. ' - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment meta: type: object properties: access: type: object description: 'Information about who has access to the given resource. This metadata is only available for single (non-batch) `GET` / `PATCH` / `POST` requests, and is not returned by default. Add `expose[meta][access]` to your query parameters to request it in the response body. ' additionalProperties: false required: - users - groups - resources properties: users: type: array description: 'A list of users that have access to this resource. These users have been given direct access; the list does not include all users who have access via a User Group or inherited resource. Each item in the list is a JSON:API Resource Identifier Object. All entries are `user`s. ' items: type: object additionalProperties: false required: - id - type properties: id: type: string format: uuid type: type: string enum: - user groups: type: array description: 'A list of groups that have access to this resource. These are all User Groups that have been created by an admin of the Opal ahead of time. Each item in the list is a JSON:API Resource Identifier Object. All entries are `user_group`s. Each user group''s name is surfaced as `meta.title` for convenience and each user group''s membership count (including all inherited membership) is surfaced as `meta.count`. ' items: type: object additionalProperties: false required: - id - type - meta properties: id: type: string format: uuid type: type: string enum: - user_group meta: type: object readOnly: true additionalProperties: false required: - title - count properties: title: type: string readOnly: true count: type: integer minimum: 0 readOnly: true resources: type: array description: 'A list of resources from which this resource _might_ inherit membership. The list always contains an entry for every other resource allowed to provide membership to the given resource. Look at the `meta.inherits_membership` property to determine if a given resource''s membership actually is being inherited. Each item in the list is a JSON:API Resource Identifier Object. Entries may have varying `types` but all resources can be retrieved separately from Opal API endpoints to get more information about them. Each resource''s name or title is surfaced as `meta.title` for convenience and each resource''s membership count (including all inherited membership) is surfaced as `meta.count`. ' items: type: object additionalProperties: false required: - id - type - meta properties: id: type: string format: uuid type: type: string meta: type: object additionalProperties: false required: - inherits_membership - title - count properties: inherits_membership: type: boolean title: type: string readOnly: true count: type: integer minimum: 0 readOnly: true included: type: array items: oneOf: - title: asset type: object required: - id - type - attributes - links - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset attributes: type: object required: - bytes - created_at - download_url_override - duration - file_extension - file_name - height - mime_type - updated_at - url - width additionalProperties: false properties: url: type: string download_url_override: type: - string - 'null' description: 'An alternative download URL for the file. If set, downloading the asset will result in a redirect to the overridden location instead of downloading the asset data directly. When not present, `url` should be used. ' width: type: - integer - 'null' description: When applicable, the width in pixels of an image or video. height: type: - integer - 'null' description: When applicable, the height in pixels of an image or video. duration: type: - integer - 'null' description: When applicable, the play time of a video in seconds. pages: type: - integer - 'null' description: When applicable, the number of pages in a PDF document. mime_type: type: string description: The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) that corresponds to the uploaded file. file_name: type: string file_extension: type: string bytes: type: integer description: The size of the file in bytes. created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true links: type: object additionalProperties: false required: - v2_request properties: v2_request: type: string format: uri relationships: required: - opal type: object additionalProperties: false properties: opal: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - opal - title: block type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block meta: type: - object - 'null' description: 'Optionally calculated block metadata which are not part of responses by default. ' additionalProperties: false properties: effective_category_type: type: - object - 'null' description: The Block resource's most immediate ancestor's Category Type. See documentation for Category Type for additional details. additionalProperties: false properties: id: type: string description: The Category Type's ID name: type: string description: The Category Type's display name description: type: - string - 'null' description: Optional additional descriptive text. deactivated_at: type: - string - 'null' format: date-time description: A flag indicating whether the category type is deactivated. effective_privacy: type: string enum: - whole_workspace - some_but_not_all description: 'The effective privacy of a resource is calculated based on all direct and inherited access. If a resource or any of its parents that it inherits access from are accessible to the entire workspace, the effective privacy is `whole_workspace`. Otherwise, the effective privacy is `some_but_not_all`. ' custom_fields: type: array description: "This metadata is available when requesting block resources from the\n`loupe/v3/blocks/{block_id}` `GET` endpoint.\n\nYou request that this metadata be included in responses with the `expose` query \nparameter like: `loupe/v3/blocks/{block_id}?expose[block][meta][custom_fields]`.\n\nEffective custom fields include both **directly assigned** and **inherited** fields from \nthe associated category type. Inherited fields may, or may not, have explicit \n`block_custom_field_value`s.\n\nThe result is a list of effective custom fields for the block. Can be empty or\ncontain multiple instances of any custom field type.\n\nOrdering:\n- Inherited custom fields appear first, ordered by the associated\n Category Type’s saved custom field order.\n- Directly assigned custom fields (via block_custom_field_values)\n follow, preserving their relative order as returned by the service.\n" items: type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - multiSelect - date - url - usersSelect description: The type of custom field. association_type: type: string description: Indicates whether the field is `direct` (explicitly assigned to the block) or `inherited` (comes from the category type). enum: - direct - inherited options: type: array description: Active options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: description: The value for this custom field. Can be null for fields that have no value set. oneOf: - title: Field Value type: object required: - id - value properties: id: type: string format: uuid description: The ID of the custom field value. value: oneOf: - title: Textarea Value type: object required: - value properties: value: type: - string - 'null' description: The text content. - title: Multi Select Value type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select Value type: object required: - id properties: id: type: - string - 'null' format: uuid description: The selected option ID. - title: Date Value type: object required: - value properties: value: type: - string - 'null' format: date-time description: The selected date. - title: URL Value type: object required: - url properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Optional display label for the URL. - title: Users Select Value type: object additionalProperties: false properties: user_ids: type: array description: List of selected user IDs. items: type: string format: uuid group_ids: type: array description: List of selected user group IDs. items: type: string format: uuid - title: 'Null' type: - object - 'null' enum: - null attributes: type: object required: - color - description - duration - title - start_at - row_index - y_scale - browsable - is_template - template_name - template_description - is_workspace_wide_template - created_at - updated_at additionalProperties: false properties: color: type: - string - 'null' description: A color applied to this block. Currently only supports hex values in the format of '#FFF' or '#FFFFFF'. description: type: - string - 'null' description: Text describing the block. Maximum length of 256 characters. title: type: string description: A descriptive name for the block. start_at: type: - string - 'null' description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the beginning of the span of time that this block resource represents. end_at: type: - string - 'null' deprecated: true description: 'DEPRECATED: migrate to `duration`. An ISO 8601-formatted (''YYYY-MM-DD'') date marking the end of the span of time that this block resource respresents. The start_at value must be a date ocurring before the end_at value.' duration: type: - string - 'null' description: 'An ISO 8601 duration string representing the length of time this block spans. Permitted formats: P{n}D (days), P{n}W (weeks), P{n}M (months). When a block has a start_at, the duration is always in days. Week and month units are only used for unscheduled blocks (start_at is null). Clients compute end_at as start_at + duration. ' row_index: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A 1-based value indicating its row position relative to other rows of blocks within their bounding parent, a Category. ' y_scale: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A value indicating how tall the block will be relative to the default size. ' browsable: type: boolean description: 'Whether this block shows up in the Plans Directory (and in the future, other directories). If false, the block is still accessible in the web application via any parent plans or connections or even by way of direct link. It just won''t show up in the Plans Directory. ' default: false created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true is_template: type: boolean readOnly: true description: 'Whether this block is a template that can be used to create new blocks. This field is read-only and cannot be set directly. Templates are created by duplicating an existing block with `is_template=true` via the block duplication endpoint. To remove a block from being a template, use the `delete` endpoint for Blocks. ' default: false is_workspace_wide_template: type: boolean description: 'Whether this template is available workspace-wide. When `true`, the template can be used across all plans in the workspace. When `false`, the template is only available within its origin plan. This field can only be set when `is_template` is `true`.' default: false template_name: type: - string - 'null' description: Display name for the template. Required when `is_template` is `true`. template_description: type: - string - 'null' description: Optional description of the template's purpose. relationships: type: object additionalProperties: false required: - creator - owner - rich_text_document - workspace properties: asset: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset boards: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board block_connectors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector category: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user owner: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user rich_text_document: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - rich_text_document workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace view: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view child_view: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value inherited_custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value paired_moment: allOf: - description: 'Only blocks of a type that supports moment pairing are allowed to have paired moments. Furthermore, this relationship is only writable when first creating a block and cannot be changed thereafter. If a block of a type that supports moment pairing is created without specifying a paired_moment, a new paired_moment is created for that block. **NOTE** that this relationship is currently [PROPOSED], not implemented. ' - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment - title: block_connector type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector attributes: type: object required: - row_index - y_scale - created_at - updated_at additionalProperties: false properties: row_index: type: integer description: A 1-based value indicating the connected block's row position relative to other rows of blocks within their bounding parent, a Category. y_scale: type: integer description: A value indicating how tall the block will be relative to the default size specified in the Category. created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - block - view additionalProperties: false properties: block: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view category: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category - title: board type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board attributes: type: object required: - created_at - description - is_public - is_archived - title - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the board. is_public: type: boolean description: 'Indicates whether or not a board and all of its contents are visible to users in the workspace. Unless otherwise specified, this value is `false` by default. Boards are always visible to the user that created them. ' is_archived: type: boolean description: 'Indicates whether or not a board has been archived. If set to `true`, the UI will only display the board in the ‘Archived Boards’ view. If set to `false` (the default), the board may be displayed in other views, depending on the user’s filter settings. ' title: type: string description: The name of the board. updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object additionalProperties: false required: - created_by_user - workspace properties: asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference board_collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_collaborator board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user object_collections: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace board_columns: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_column board_user_setting: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_user_setting default_story: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - story - title: category type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category attributes: type: object required: - title - position - block_size - view_mode - group_by_strategy - group_by_exclude_empty_groupings - depth - is_supportive - created_at - updated_at additionalProperties: false properties: title: type: string description: A descriptive name for the category. depth: type: integer readOnly: true description: This is a read-only calculated field. Given that a category can have a parent category, depth is a zero-based indication of how far removed this category is from the root category. position: type: integer description: A zero-based value indicating its position relative to other categories at the same depth. block_size: type: string description: An enumeration representing the sizes of block resources within the category. enum: - small - medium - large view_mode: type: string description: An enumeration representing the display mode of the category. enum: - default - condensed group_by_strategy: type: - string - 'null' description: 'An enumeration representing the grouping strategy of a category, part of instructions to the client on how children within the category should be displayed. If set to `custom_field`, then the the `group_by_custom_field` relationship must also be provided. ' enum: - null - category_type - custom_field group_by_exclude_empty_groupings: type: boolean default: true description: 'Part of instructions to the client on how children within the category should be displayed. Inidicates whether groupings that are empty should be hidden from view. Defaults to true. ' is_supportive: type: boolean default: false description: 'Indicates that the category contains blocks native to other views, and that the blocks within are here "in support of" this category''s view. Categories with this attribute set to `true` are created internally by the system, and cannot be edited. ' readOnly: true created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true relationships: type: object additionalProperties: false required: - block_connectors - blocks - charts - creator - view properties: block_template: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block block_connectors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector blocks: deprecated: true description: 'Reading blocks directly through the category has been deprecated in favor of reading block_connectors. ' type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type charts: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - chart creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user filter_set: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - filter_set group_by_custom_field: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field parent_category: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view meta: type: object required: - effective_category_type_id properties: effective_category_type_id: type: - string - 'null' format: uuid description: 'The id of the “effective” `category_type` relationship for this `category` resource, as described in [the Categories overview](/api/documentation/v3#tag/Categories).' readOnly: true - title: category_type type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type attributes: type: object required: - created_at - name - supported_paired_type additionalProperties: false properties: name: type: string description: The name that will be displayed in the Opal application UI. description: type: - string - 'null' description: A description of the record. supported_paired_type: type: - string - 'null' default: null enum: - moment - null description: Whether blocks of this type will have resources of the given type paired with them. Moment pairing allows teams to work with the same resources from the Plan (via blocks) or from a Board or Calendar (via Moments). Once set to 'moment', this property cannot be set back to null. Blocks created with a type that supports moment pairing will always have paired moments. Conversely, blocks created with types that do not support moment pairing will not have paired moments (unless moment pairing support is added to the type later). created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true deactivated_at: type: - string - 'null' format: date-time description: An RFC 3339 date-time. If present, indicates the record has been deactivated (but not deleted). has_explicit_custom_field_order: type: boolean default: false description: 'If true, the category type uses its own saved order for `custom_fields`. If false, ordering falls back to the global custom field order (e.g., `custom_fields.created_at`). ' relationships: type: object required: - creator - workspace - in_support_of_category_types additionalProperties: false properties: creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace custom_fields: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field default_child_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type in_support_of_category_types: description: 'A list of category_types that this type is configured to support. ' type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type - title: key_date type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - key_date attributes: type: object required: - title - color - start_date - end_date - created_at - updated_at additionalProperties: false properties: title: type: string description: A descriptive name for the key event or date. color: type: - string - 'null' description: A color for this key date. The value must be in hex format, such as '#FFF' or '#FFFFFF'. start_date: type: string description: The start of the period, represented as an ISO 8601-formatted ('YYYY-MM-DD') date, when this key event or date begins to be observed. A single-day event can be represented with a start_date and a null end_date. end_date: type: - string - 'null' description: The end of the period, represented as an ISO 8601-formatted ('YYYY-MM-DD') date, when this key event or date ceases to be observed. created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true relationships: type: object additionalProperties: false required: - view properties: view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view - title: view type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view meta: type: - object - 'null' description: 'Optionally calculated view metadata which are not part of responses by default. ' additionalProperties: false properties: effective_privacy: type: string enum: - whole_workspace - some_but_not_all description: 'The effective privacy of a resource is calculated based on all direct and inherited access. If a resource or any of its parents that it inherits access from are accessible to the entire workspace, the effective privacy is `whole_workspace`. Otherwise, the effective privacy is `some_but_not_all`. ' attributes: type: object required: - title - kind - start_at - end_at - description - default_timescale - created_at - updated_at - start_month_index - start_weekday_index - show_smart_swimlane_datasource - swimlane_title_column_width additionalProperties: false properties: title: type: string description: A descriptive name for the view. description: type: - string - 'null' description: A field allowing for additional descriptive text. kind: type: string description: An enumeration representing the view type. Currently only supports Plan views. enum: - plan default_timescale: type: string description: An enumeration representing the timescale of this view. enum: - day - week - month - quarter start_at: type: string description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the beginning of the span of time that this view resource respresents. The start_at value must be a date ocurring before the end_at value. end_at: type: string description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the end of the span of time that this view resource respresents. The start_at value must be a date ocurring before the end_at value. created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true start_month_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 description: Start month index for the plan. Specifies the number of months, 0 to 11, to offset from January. 0 by default, meaning no offset. If set, e.g., 1, start in February. start_weekday_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 description: Start weekday index for the plan. Specifies the days in a week, 0 to 6 (Sunday to Saturday). 0 (Sunday) is the default. If set to, e.g., 1, weeks will start on Monday. show_smart_swimlane_datasource: type: boolean description: Whether to display the datasource filter information on smart swimlanes. Defaults to true. swimlane_title_column_width: type: integer description: The width in pixels of the swimlane title column from 200 to 800 for persistence across sessions. Defaults to 200. relationships: type: object additionalProperties: false required: - categories - blocks - owner - creator - workspace - colors - key_dates - parent_block properties: categories: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type blocks: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block owner: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace colors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view_color key_dates: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - key_date parent_block: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block - title: view_color type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view_color attributes: type: object required: - label - color - created_at - updated_at additionalProperties: false properties: label: type: - string - 'null' description: A descriptive name for the color. color: type: string description: A color in hex format. Currently only supports hex values in the format of '#FFF' or '#FFFFFF'. created_at: type: string readOnly: true format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. updated_at: type: string readOnly: true format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. relationships: type: object additionalProperties: false required: - view properties: view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view example: data: id: f649cebe-3dce-441a-8335-86707303c388 type: block attributes: color: '#00FFFF' description: Just kidding, it's always time for coffee. title: Time For Coffee start_at: '2024-01-01' end_at: '2024-12-31' duration: P364D row_index: 1 y_scale: 1 is_template: false is_workspace_wide_template: false browsable: false template_name: null template_description: null created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' relationships: workspace: data: id: a897cb4c-12d3-446f-9621-ff388650d43a type: workspace view: data: id: c3f80757-c0ea-422c-aa51-3c9ef8e11a76 type: view category: data: id: 24b4dd04-e56a-4794-95fa-ea0a0709b5a6 type: category rich_text_document: data: id: 0f8d6b6f-0b32-404d-9d81-7864c3969ac0 type: rich_text_document asset: data: id: 48517d52-3a25-4ca6-a7f5-55a3817fc00f type: asset block_connectors: data: - id: 4cda51c0-3d53-44fe-8bd5-0b294ed1fe78 type: block_connector boards: data: - id: d19806fe-55b3-4682-9d67-07343fea3975 type: board creator: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user owner: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user child_view: data: id: e01b9a23-01f4-447d-96fd-03188fc9edd1 type: view custom_field_values: data: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 type: block_custom_field_value - id: b2c3d4e5-f6g7-8901-bcde-f23456789012 type: block_custom_field_value inherited_custom_field_values: data: - id: f597cbaa-c10c-4538-8bcf-6c2dadacb727 type: block_custom_field_value '400': description: Bad request content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '401': description: Unauthorized content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '403': description: Forbidden content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '422': description: Unprocessable entity content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '500': description: "May also contain a `code` indicating additional context:\n\n- \"access_read_failed\": The operation completed successfully, but the\n server encountered an error reading access metadata. The resource\n may still be readable.\n" content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status servers: - url: https://login.ouropal.com /loupe/v3/blocks/{block_id}: get: tags: - Blocks operationId: ReadBlockV3 x-Operation-ID: ReadBlockV3 summary: Get a Block by the given ID security: - oauth2: - offline_access - api_key: [] parameters: - name: block_id in: path required: true description: The ID of the Block. schema: type: string format: uuid - name: include in: query required: false description: A comma separated value of related objects to include. schema: type: array items: type: string enum: - asset - block_connectors - block_connectors.category - block_connectors.category.category_type - block_connectors.view - block_connectors.view.categories - block_connectors.view.colors - block_connectors.view.key_dates - block_connectors.view.parent_block - boards - category - category.category_type - child_view - child_view.categories - child_view.colors - child_view.key_dates - custom_field_values - custom_field_values.custom_field - custom_field_values.custom_field.custom_field_type - custom_field_values.groups - custom_field_values.users - inherited_custom_field_values - inherited_custom_field_values.custom_field - inherited_custom_field_values.custom_field.custom_field_type - inherited_custom_field_values.groups - inherited_custom_field_values.users - view - view.categories - view.colors - view.key_dates - view.parent_block - view.parent_block.view style: form explode: false - name: expose in: query required: false description: 'Optionally calculated view metadata which are not part of responses by default. You request that metadata be included in responses with the `expose` query parameter like: `?expose[block][meta]` or `?expose[meta][access]`. ' style: deepObject explode: true schema: type: object additionalProperties: false properties: meta: type: object properties: access: type: - string - 'null' description: 'Information about who has access to the given resource. This metadata is only available for single (non-batch) `GET` / `PATCH` / `POST` requests, and is not returned by default. Add `expose[meta][access]` to your query parameters to request it in the response body. ' block: type: object properties: meta: type: object properties: custom_fields: type: - string - 'null' description: 'Expose the custom fields available to the block resource. These custom fields may be inherited or directly associated with the block. Inherited custom fields may or may not have a custom field value. Use this parameter as: `?expose[block][meta][custom_fields]` ' effective_privacy: type: - string - 'null' description: 'Expose the effective privacy of the block resource. Use this parameter as: `?expose[block][meta][effective_privacy]` ' - name: omit in: query required: false description: 'Optionally omit part of the calculated block metadata. This is currently only available when requesting moment resources from the `/loupe/v3/blocks/{id}` `GET` endpoint. You request that this metadata be included in responses with the `expose` query parameter like: `/loupe/v3/blocks/{id}?expose[meta][access]`. Then you can omit resource access metadata for paired moments (if relevant) with `omit[meta][access]=paired_resources`. ' style: deepObject explode: true schema: type: object properties: meta: type: object properties: access: type: array items: type: string enum: - paired_resources responses: '200': description: The requested Block content: application/json: schema: type: object required: - data properties: data: title: block type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block meta: type: - object - 'null' description: 'Optionally calculated block metadata which are not part of responses by default. ' additionalProperties: false properties: effective_category_type: type: - object - 'null' description: The Block resource's most immediate ancestor's Category Type. See documentation for Category Type for additional details. additionalProperties: false properties: id: type: string description: The Category Type's ID name: type: string description: The Category Type's display name description: type: - string - 'null' description: Optional additional descriptive text. deactivated_at: type: - string - 'null' format: date-time description: A flag indicating whether the category type is deactivated. effective_privacy: type: string enum: - whole_workspace - some_but_not_all description: 'The effective privacy of a resource is calculated based on all direct and inherited access. If a resource or any of its parents that it inherits access from are accessible to the entire workspace, the effective privacy is `whole_workspace`. Otherwise, the effective privacy is `some_but_not_all`. ' custom_fields: type: array description: "This metadata is available when requesting block resources from the\n`loupe/v3/blocks/{block_id}` `GET` endpoint.\n\nYou request that this metadata be included in responses with the `expose` query \nparameter like: `loupe/v3/blocks/{block_id}?expose[block][meta][custom_fields]`.\n\nEffective custom fields include both **directly assigned** and **inherited** fields from \nthe associated category type. Inherited fields may, or may not, have explicit \n`block_custom_field_value`s.\n\nThe result is a list of effective custom fields for the block. Can be empty or\ncontain multiple instances of any custom field type.\n\nOrdering:\n- Inherited custom fields appear first, ordered by the associated\n Category Type’s saved custom field order.\n- Directly assigned custom fields (via block_custom_field_values)\n follow, preserving their relative order as returned by the service.\n" items: type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - multiSelect - date - url - usersSelect description: The type of custom field. association_type: type: string description: Indicates whether the field is `direct` (explicitly assigned to the block) or `inherited` (comes from the category type). enum: - direct - inherited options: type: array description: Active options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: description: The value for this custom field. Can be null for fields that have no value set. oneOf: - title: Field Value type: object required: - id - value properties: id: type: string format: uuid description: The ID of the custom field value. value: oneOf: - title: Textarea Value type: object required: - value properties: value: type: - string - 'null' description: The text content. - title: Multi Select Value type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select Value type: object required: - id properties: id: type: - string - 'null' format: uuid description: The selected option ID. - title: Date Value type: object required: - value properties: value: type: - string - 'null' format: date-time description: The selected date. - title: URL Value type: object required: - url properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Optional display label for the URL. - title: Users Select Value type: object additionalProperties: false properties: user_ids: type: array description: List of selected user IDs. items: type: string format: uuid group_ids: type: array description: List of selected user group IDs. items: type: string format: uuid - title: 'Null' type: - object - 'null' enum: - null attributes: type: object required: - color - description - duration - title - start_at - row_index - y_scale - browsable - is_template - template_name - template_description - is_workspace_wide_template - created_at - updated_at additionalProperties: false properties: color: type: - string - 'null' description: A color applied to this block. Currently only supports hex values in the format of '#FFF' or '#FFFFFF'. description: type: - string - 'null' description: Text describing the block. Maximum length of 256 characters. title: type: string description: A descriptive name for the block. start_at: type: - string - 'null' description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the beginning of the span of time that this block resource represents. end_at: type: - string - 'null' deprecated: true description: 'DEPRECATED: migrate to `duration`. An ISO 8601-formatted (''YYYY-MM-DD'') date marking the end of the span of time that this block resource respresents. The start_at value must be a date ocurring before the end_at value.' duration: type: - string - 'null' description: 'An ISO 8601 duration string representing the length of time this block spans. Permitted formats: P{n}D (days), P{n}W (weeks), P{n}M (months). When a block has a start_at, the duration is always in days. Week and month units are only used for unscheduled blocks (start_at is null). Clients compute end_at as start_at + duration. ' row_index: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A 1-based value indicating its row position relative to other rows of blocks within their bounding parent, a Category. ' y_scale: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A value indicating how tall the block will be relative to the default size. ' browsable: type: boolean description: 'Whether this block shows up in the Plans Directory (and in the future, other directories). If false, the block is still accessible in the web application via any parent plans or connections or even by way of direct link. It just won''t show up in the Plans Directory. ' default: false created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true is_template: type: boolean readOnly: true description: 'Whether this block is a template that can be used to create new blocks. This field is read-only and cannot be set directly. Templates are created by duplicating an existing block with `is_template=true` via the block duplication endpoint. To remove a block from being a template, use the `delete` endpoint for Blocks. ' default: false is_workspace_wide_template: type: boolean description: 'Whether this template is available workspace-wide. When `true`, the template can be used across all plans in the workspace. When `false`, the template is only available within its origin plan. This field can only be set when `is_template` is `true`.' default: false template_name: type: - string - 'null' description: Display name for the template. Required when `is_template` is `true`. template_description: type: - string - 'null' description: Optional description of the template's purpose. relationships: type: object additionalProperties: false required: - creator - owner - rich_text_document - workspace properties: asset: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset boards: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board block_connectors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector category: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user owner: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user rich_text_document: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - rich_text_document workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace view: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view child_view: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value inherited_custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value paired_moment: allOf: - description: 'Only blocks of a type that supports moment pairing are allowed to have paired moments. Furthermore, this relationship is only writable when first creating a block and cannot be changed thereafter. If a block of a type that supports moment pairing is created without specifying a paired_moment, a new paired_moment is created for that block. **NOTE** that this relationship is currently [PROPOSED], not implemented. ' - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment meta: type: object properties: access: type: object description: 'Information about who has access to the given resource. This metadata is only available for single (non-batch) `GET` / `PATCH` / `POST` requests, and is not returned by default. Add `expose[meta][access]` to your query parameters to request it in the response body. ' additionalProperties: false required: - users - groups - resources properties: users: type: array description: 'A list of users that have access to this resource. These users have been given direct access; the list does not include all users who have access via a User Group or inherited resource. Each item in the list is a JSON:API Resource Identifier Object. All entries are `user`s. ' items: type: object additionalProperties: false required: - id - type properties: id: type: string format: uuid type: type: string enum: - user groups: type: array description: 'A list of groups that have access to this resource. These are all User Groups that have been created by an admin of the Opal ahead of time. Each item in the list is a JSON:API Resource Identifier Object. All entries are `user_group`s. Each user group''s name is surfaced as `meta.title` for convenience and each user group''s membership count (including all inherited membership) is surfaced as `meta.count`. ' items: type: object additionalProperties: false required: - id - type - meta properties: id: type: string format: uuid type: type: string enum: - user_group meta: type: object readOnly: true additionalProperties: false required: - title - count properties: title: type: string readOnly: true count: type: integer minimum: 0 readOnly: true resources: type: array description: 'A list of resources from which this resource _might_ inherit membership. The list always contains an entry for every other resource allowed to provide membership to the given resource. Look at the `meta.inherits_membership` property to determine if a given resource''s membership actually is being inherited. Each item in the list is a JSON:API Resource Identifier Object. Entries may have varying `types` but all resources can be retrieved separately from Opal API endpoints to get more information about them. Each resource''s name or title is surfaced as `meta.title` for convenience and each resource''s membership count (including all inherited membership) is surfaced as `meta.count`. ' items: type: object additionalProperties: false required: - id - type - meta properties: id: type: string format: uuid type: type: string meta: type: object additionalProperties: false required: - inherits_membership - title - count properties: inherits_membership: type: boolean title: type: string readOnly: true count: type: integer minimum: 0 readOnly: true included: type: array items: oneOf: - title: asset type: object required: - id - type - attributes - links - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset attributes: type: object required: - bytes - created_at - download_url_override - duration - file_extension - file_name - height - mime_type - updated_at - url - width additionalProperties: false properties: url: type: string download_url_override: type: - string - 'null' description: 'An alternative download URL for the file. If set, downloading the asset will result in a redirect to the overridden location instead of downloading the asset data directly. When not present, `url` should be used. ' width: type: - integer - 'null' description: When applicable, the width in pixels of an image or video. height: type: - integer - 'null' description: When applicable, the height in pixels of an image or video. duration: type: - integer - 'null' description: When applicable, the play time of a video in seconds. pages: type: - integer - 'null' description: When applicable, the number of pages in a PDF document. mime_type: type: string description: The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) that corresponds to the uploaded file. file_name: type: string file_extension: type: string bytes: type: integer description: The size of the file in bytes. created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true links: type: object additionalProperties: false required: - v2_request properties: v2_request: type: string format: uri relationships: required: - opal type: object additionalProperties: false properties: opal: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - opal - title: block type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block meta: type: - object - 'null' description: 'Optionally calculated block metadata which are not part of responses by default. ' additionalProperties: false properties: effective_category_type: type: - object - 'null' description: The Block resource's most immediate ancestor's Category Type. See documentation for Category Type for additional details. additionalProperties: false properties: id: type: string description: The Category Type's ID name: type: string description: The Category Type's display name description: type: - string - 'null' description: Optional additional descriptive text. deactivated_at: type: - string - 'null' format: date-time description: A flag indicating whether the category type is deactivated. effective_privacy: type: string enum: - whole_workspace - some_but_not_all description: 'The effective privacy of a resource is calculated based on all direct and inherited access. If a resource or any of its parents that it inherits access from are accessible to the entire workspace, the effective privacy is `whole_workspace`. Otherwise, the effective privacy is `some_but_not_all`. ' custom_fields: type: array description: "This metadata is available when requesting block resources from the\n`loupe/v3/blocks/{block_id}` `GET` endpoint.\n\nYou request that this metadata be included in responses with the `expose` query \nparameter like: `loupe/v3/blocks/{block_id}?expose[block][meta][custom_fields]`.\n\nEffective custom fields include both **directly assigned** and **inherited** fields from \nthe associated category type. Inherited fields may, or may not, have explicit \n`block_custom_field_value`s.\n\nThe result is a list of effective custom fields for the block. Can be empty or\ncontain multiple instances of any custom field type.\n\nOrdering:\n- Inherited custom fields appear first, ordered by the associated\n Category Type’s saved custom field order.\n- Directly assigned custom fields (via block_custom_field_values)\n follow, preserving their relative order as returned by the service.\n" items: type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - multiSelect - date - url - usersSelect description: The type of custom field. association_type: type: string description: Indicates whether the field is `direct` (explicitly assigned to the block) or `inherited` (comes from the category type). enum: - direct - inherited options: type: array description: Active options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: description: The value for this custom field. Can be null for fields that have no value set. oneOf: - title: Field Value type: object required: - id - value properties: id: type: string format: uuid description: The ID of the custom field value. value: oneOf: - title: Textarea Value type: object required: - value properties: value: type: - string - 'null' description: The text content. - title: Multi Select Value type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select Value type: object required: - id properties: id: type: - string - 'null' format: uuid description: The selected option ID. - title: Date Value type: object required: - value properties: value: type: - string - 'null' format: date-time description: The selected date. - title: URL Value type: object required: - url properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Optional display label for the URL. - title: Users Select Value type: object additionalProperties: false properties: user_ids: type: array description: List of selected user IDs. items: type: string format: uuid group_ids: type: array description: List of selected user group IDs. items: type: string format: uuid - title: 'Null' type: - object - 'null' enum: - null attributes: type: object required: - color - description - duration - title - start_at - row_index - y_scale - browsable - is_template - template_name - template_description - is_workspace_wide_template - created_at - updated_at additionalProperties: false properties: color: type: - string - 'null' description: A color applied to this block. Currently only supports hex values in the format of '#FFF' or '#FFFFFF'. description: type: - string - 'null' description: Text describing the block. Maximum length of 256 characters. title: type: string description: A descriptive name for the block. start_at: type: - string - 'null' description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the beginning of the span of time that this block resource represents. end_at: type: - string - 'null' deprecated: true description: 'DEPRECATED: migrate to `duration`. An ISO 8601-formatted (''YYYY-MM-DD'') date marking the end of the span of time that this block resource respresents. The start_at value must be a date ocurring before the end_at value.' duration: type: - string - 'null' description: 'An ISO 8601 duration string representing the length of time this block spans. Permitted formats: P{n}D (days), P{n}W (weeks), P{n}M (months). When a block has a start_at, the duration is always in days. Week and month units are only used for unscheduled blocks (start_at is null). Clients compute end_at as start_at + duration. ' row_index: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A 1-based value indicating its row position relative to other rows of blocks within their bounding parent, a Category. ' y_scale: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A value indicating how tall the block will be relative to the default size. ' browsable: type: boolean description: 'Whether this block shows up in the Plans Directory (and in the future, other directories). If false, the block is still accessible in the web application via any parent plans or connections or even by way of direct link. It just won''t show up in the Plans Directory. ' default: false created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true is_template: type: boolean readOnly: true description: 'Whether this block is a template that can be used to create new blocks. This field is read-only and cannot be set directly. Templates are created by duplicating an existing block with `is_template=true` via the block duplication endpoint. To remove a block from being a template, use the `delete` endpoint for Blocks. ' default: false is_workspace_wide_template: type: boolean description: 'Whether this template is available workspace-wide. When `true`, the template can be used across all plans in the workspace. When `false`, the template is only available within its origin plan. This field can only be set when `is_template` is `true`.' default: false template_name: type: - string - 'null' description: Display name for the template. Required when `is_template` is `true`. template_description: type: - string - 'null' description: Optional description of the template's purpose. relationships: type: object additionalProperties: false required: - creator - owner - rich_text_document - workspace properties: asset: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset boards: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board block_connectors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector category: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user owner: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user rich_text_document: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - rich_text_document workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace view: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view child_view: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value inherited_custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value paired_moment: allOf: - description: 'Only blocks of a type that supports moment pairing are allowed to have paired moments. Furthermore, this relationship is only writable when first creating a block and cannot be changed thereafter. If a block of a type that supports moment pairing is created without specifying a paired_moment, a new paired_moment is created for that block. **NOTE** that this relationship is currently [PROPOSED], not implemented. ' - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment - title: block_connector type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector attributes: type: object required: - row_index - y_scale - created_at - updated_at additionalProperties: false properties: row_index: type: integer description: A 1-based value indicating the connected block's row position relative to other rows of blocks within their bounding parent, a Category. y_scale: type: integer description: A value indicating how tall the block will be relative to the default size specified in the Category. created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - block - view additionalProperties: false properties: block: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view category: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category - title: board type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board attributes: type: object required: - created_at - description - is_public - is_archived - title - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the board. is_public: type: boolean description: 'Indicates whether or not a board and all of its contents are visible to users in the workspace. Unless otherwise specified, this value is `false` by default. Boards are always visible to the user that created them. ' is_archived: type: boolean description: 'Indicates whether or not a board has been archived. If set to `true`, the UI will only display the board in the ‘Archived Boards’ view. If set to `false` (the default), the board may be displayed in other views, depending on the user’s filter settings. ' title: type: string description: The name of the board. updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object additionalProperties: false required: - created_by_user - workspace properties: asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference board_collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_collaborator board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user object_collections: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace board_columns: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_column board_user_setting: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_user_setting default_story: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - story - title: category type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category attributes: type: object required: - title - position - block_size - view_mode - group_by_strategy - group_by_exclude_empty_groupings - depth - is_supportive - created_at - updated_at additionalProperties: false properties: title: type: string description: A descriptive name for the category. depth: type: integer readOnly: true description: This is a read-only calculated field. Given that a category can have a parent category, depth is a zero-based indication of how far removed this category is from the root category. position: type: integer description: A zero-based value indicating its position relative to other categories at the same depth. block_size: type: string description: An enumeration representing the sizes of block resources within the category. enum: - small - medium - large view_mode: type: string description: An enumeration representing the display mode of the category. enum: - default - condensed group_by_strategy: type: - string - 'null' description: 'An enumeration representing the grouping strategy of a category, part of instructions to the client on how children within the category should be displayed. If set to `custom_field`, then the the `group_by_custom_field` relationship must also be provided. ' enum: - null - category_type - custom_field group_by_exclude_empty_groupings: type: boolean default: true description: 'Part of instructions to the client on how children within the category should be displayed. Inidicates whether groupings that are empty should be hidden from view. Defaults to true. ' is_supportive: type: boolean default: false description: 'Indicates that the category contains blocks native to other views, and that the blocks within are here "in support of" this category''s view. Categories with this attribute set to `true` are created internally by the system, and cannot be edited. ' readOnly: true created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true relationships: type: object additionalProperties: false required: - block_connectors - blocks - charts - creator - view properties: block_template: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block block_connectors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector blocks: deprecated: true description: 'Reading blocks directly through the category has been deprecated in favor of reading block_connectors. ' type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type charts: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - chart creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user filter_set: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - filter_set group_by_custom_field: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field parent_category: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view meta: type: object required: - effective_category_type_id properties: effective_category_type_id: type: - string - 'null' format: uuid description: 'The id of the “effective” `category_type` relationship for this `category` resource, as described in [the Categories overview](/api/documentation/v3#tag/Categories).' readOnly: true - title: category_type type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type attributes: type: object required: - created_at - name - supported_paired_type additionalProperties: false properties: name: type: string description: The name that will be displayed in the Opal application UI. description: type: - string - 'null' description: A description of the record. supported_paired_type: type: - string - 'null' default: null enum: - moment - null description: Whether blocks of this type will have resources of the given type paired with them. Moment pairing allows teams to work with the same resources from the Plan (via blocks) or from a Board or Calendar (via Moments). Once set to 'moment', this property cannot be set back to null. Blocks created with a type that supports moment pairing will always have paired moments. Conversely, blocks created with types that do not support moment pairing will not have paired moments (unless moment pairing support is added to the type later). created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true deactivated_at: type: - string - 'null' format: date-time description: An RFC 3339 date-time. If present, indicates the record has been deactivated (but not deleted). has_explicit_custom_field_order: type: boolean default: false description: 'If true, the category type uses its own saved order for `custom_fields`. If false, ordering falls back to the global custom field order (e.g., `custom_fields.created_at`). ' relationships: type: object required: - creator - workspace - in_support_of_category_types additionalProperties: false properties: creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace custom_fields: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field default_child_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type in_support_of_category_types: description: 'A list of category_types that this type is configured to support. ' type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type - title: key_date type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - key_date attributes: type: object required: - title - color - start_date - end_date - created_at - updated_at additionalProperties: false properties: title: type: string description: A descriptive name for the key event or date. color: type: - string - 'null' description: A color for this key date. The value must be in hex format, such as '#FFF' or '#FFFFFF'. start_date: type: string description: The start of the period, represented as an ISO 8601-formatted ('YYYY-MM-DD') date, when this key event or date begins to be observed. A single-day event can be represented with a start_date and a null end_date. end_date: type: - string - 'null' description: The end of the period, represented as an ISO 8601-formatted ('YYYY-MM-DD') date, when this key event or date ceases to be observed. created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true relationships: type: object additionalProperties: false required: - view properties: view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view - title: view type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view meta: type: - object - 'null' description: 'Optionally calculated view metadata which are not part of responses by default. ' additionalProperties: false properties: effective_privacy: type: string enum: - whole_workspace - some_but_not_all description: 'The effective privacy of a resource is calculated based on all direct and inherited access. If a resource or any of its parents that it inherits access from are accessible to the entire workspace, the effective privacy is `whole_workspace`. Otherwise, the effective privacy is `some_but_not_all`. ' attributes: type: object required: - title - kind - start_at - end_at - description - default_timescale - created_at - updated_at - start_month_index - start_weekday_index - show_smart_swimlane_datasource - swimlane_title_column_width additionalProperties: false properties: title: type: string description: A descriptive name for the view. description: type: - string - 'null' description: A field allowing for additional descriptive text. kind: type: string description: An enumeration representing the view type. Currently only supports Plan views. enum: - plan default_timescale: type: string description: An enumeration representing the timescale of this view. enum: - day - week - month - quarter start_at: type: string description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the beginning of the span of time that this view resource respresents. The start_at value must be a date ocurring before the end_at value. end_at: type: string description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the end of the span of time that this view resource respresents. The start_at value must be a date ocurring before the end_at value. created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true start_month_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 description: Start month index for the plan. Specifies the number of months, 0 to 11, to offset from January. 0 by default, meaning no offset. If set, e.g., 1, start in February. start_weekday_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 description: Start weekday index for the plan. Specifies the days in a week, 0 to 6 (Sunday to Saturday). 0 (Sunday) is the default. If set to, e.g., 1, weeks will start on Monday. show_smart_swimlane_datasource: type: boolean description: Whether to display the datasource filter information on smart swimlanes. Defaults to true. swimlane_title_column_width: type: integer description: The width in pixels of the swimlane title column from 200 to 800 for persistence across sessions. Defaults to 200. relationships: type: object additionalProperties: false required: - categories - blocks - owner - creator - workspace - colors - key_dates - parent_block properties: categories: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type blocks: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block owner: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace colors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view_color key_dates: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - key_date parent_block: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block - title: view_color type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view_color attributes: type: object required: - label - color - created_at - updated_at additionalProperties: false properties: label: type: - string - 'null' description: A descriptive name for the color. color: type: string description: A color in hex format. Currently only supports hex values in the format of '#FFF' or '#FFFFFF'. created_at: type: string readOnly: true format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. updated_at: type: string readOnly: true format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. relationships: type: object additionalProperties: false required: - view properties: view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view example: data: id: f649cebe-3dce-441a-8335-86707303c388 type: block attributes: color: '#00FFFF' description: Just kidding, it's always time for coffee. title: Time For Coffee start_at: '2024-01-01' end_at: '2024-12-31' duration: P364D row_index: 1 y_scale: 1 is_template: false is_workspace_wide_template: false browsable: false template_name: null template_description: null created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' relationships: workspace: data: id: a897cb4c-12d3-446f-9621-ff388650d43a type: workspace view: data: id: c3f80757-c0ea-422c-aa51-3c9ef8e11a76 type: view category: data: id: 24b4dd04-e56a-4794-95fa-ea0a0709b5a6 type: category rich_text_document: data: id: 0f8d6b6f-0b32-404d-9d81-7864c3969ac0 type: rich_text_document asset: data: id: 48517d52-3a25-4ca6-a7f5-55a3817fc00f type: asset block_connectors: data: - id: 4cda51c0-3d53-44fe-8bd5-0b294ed1fe78 type: block_connector boards: data: - id: d19806fe-55b3-4682-9d67-07343fea3975 type: board creator: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user owner: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user child_view: data: id: e01b9a23-01f4-447d-96fd-03188fc9edd1 type: view custom_field_values: data: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 type: block_custom_field_value - id: b2c3d4e5-f6g7-8901-bcde-f23456789012 type: block_custom_field_value inherited_custom_field_values: data: - id: f597cbaa-c10c-4538-8bcf-6c2dadacb727 type: block_custom_field_value '401': description: Unauthorized content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '403': description: Forbidden content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '404': description: Not found content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status patch: tags: - Blocks operationId: UpdateBlockV3 x-Operation-ID: UpdateBlockV3 summary: Update an existing Block. security: - oauth2: - offline_access - api_key: [] parameters: - name: block_id in: path required: true description: The ID of the Block. schema: type: string format: uuid - name: include in: query required: false description: A comma separated value of related objects to include. schema: type: array items: type: string enum: - asset - block_connectors - block_connectors.category - block_connectors.category.category_type - block_connectors.view - block_connectors.view.categories - block_connectors.view.colors - block_connectors.view.key_dates - block_connectors.view.parent_block - boards - category - category.category_type - child_view - child_view.categories - child_view.colors - child_view.key_dates - custom_field_values - custom_field_values.custom_field - custom_field_values.custom_field.custom_field_type - custom_field_values.groups - custom_field_values.users - inherited_custom_field_values - inherited_custom_field_values.custom_field - inherited_custom_field_values.custom_field.custom_field_type - inherited_custom_field_values.groups - inherited_custom_field_values.users - view - view.categories - view.colors - view.key_dates - view.parent_block - view.parent_block.view style: form explode: false - name: expose description: Ask for Access metadata to be returned. in: query required: false schema: type: object properties: meta: type: object properties: access: type: - string - 'null' description: 'Information about who has access to the given resource. This metadata is only available for single (non-batch) `GET` / `PATCH` / `POST` requests, and is not returned by default. Add `expose[meta][access]` to your query parameters to request it in the response body. ' style: deepObject explode: true requestBody: content: application/json: schema: type: object required: - data properties: data: type: object required: - id - type - attributes properties: id: type: string format: uuid type: type: string enum: - block attributes: type: object properties: color: type: - string - 'null' description: A color applied to this block. Currently only supports hex values in the format of '#FFF' or '#FFFFFF'. description: type: - string - 'null' maxLength: 256 description: Text describing the block. Maximum length of 256 characters. title: type: string description: A descriptive name for the block. start_at: type: - string - 'null' format: date description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the beginning of the span of time that this block resource represents. duration: type: - string - 'null' description: 'An ISO 8601 duration string: P{n}D (days), P{n}W (weeks), or P{n}M (months). Week and month units are auto-normalized to days when `start_at` is provided. When only `start_at` changes, the duration is automatically recalculated. When `start_at` is set to null without an explicit duration, duration is cleared. ' row_index: type: integer description: 'A 1-based value indicating its row position relative to other rows of blocks within their bounding parent, a Category. Setting this attribute when the block has multiple block_connectors will result in an error. This attribute should instead be modified directly on the relevant block_connector. ' deprecated: true y_scale: type: integer description: 'A value indicating how tall the block will be relative to the default size. Setting this attribute when the block has multiple block_connectors will result in an error. This attribute should instead be modified directly on the relevant block_connector. ' deprecated: true browsable: type: boolean description: 'Whether this block shows up in the Plans Directory (and in the future, other directories). If false, the block is still accessible in the web application via any parent plans or connections or even by way of direct link. It just won''t show up in the Plans Directory. ' default: false is_template: type: boolean description: 'Whether this block is a template that can be used to create new blocks. Currently, templated Blocks cannot be created from paired Blocks. ' default: false is_workspace_wide_template: type: boolean description: 'Whether this template is available workspace-wide. When `true`, the template can be used across all plans in the workspace. When `false`, the template is only available within its origin plan. This field can only be set when `is_template` is `true`.' default: false template_name: type: - string - 'null' description: Display name for the template. Required when `is_template` is `true`. Cannot be set to null on a template. template_description: type: - string - 'null' description: Optional description of the template's purpose. relationships: type: object properties: asset: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset boards: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board category: deprecated: true description: 'Modifying this relationship when the block has multiple block_connectors will result in an error. This relationship should instead be modified directly on the relevant block_connector. ' type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type owner: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user meta: type: object properties: access: type: object description: 'Information about who has access to the given resource. This metadata is only available for single (non-batch) `GET` / `PATCH` / `POST` requests, and is not returned by default. Add `expose[meta][access]` to your query parameters to request it in the response body. ' additionalProperties: false properties: users: type: array description: 'A list of users that have access to this resource. These users have been given direct access; the list does not include all users who have access via a User Group or inherited resource. Each item in the list is a JSON:API Resource Identifier Object. All entries are `user`s. ' items: type: object additionalProperties: false required: - id - type properties: id: type: string format: uuid type: type: string enum: - user groups: type: array description: 'A list of groups that have access to this resource. These are all User Groups that have been created by an admin of the Opal ahead of time. Each item in the list is a JSON:API Resource Identifier Object. All entries are `user_group`s. ' items: type: object additionalProperties: false required: - id - type properties: id: type: string format: uuid type: type: string enum: - user_group resources: type: array description: 'A list of resources from which this resource _might_ inherit membership. The list always contains an entry for every other resource allowed to provide membership to the given resource. Set the `meta.inherits_membership` property to determine if a given resource''s membership actually is being inherited. Each item in the list is a JSON:API Resource Identifier Object. Entries may have varying `types`. ' items: type: object additionalProperties: false required: - id - type - meta properties: id: type: string format: uuid type: type: string meta: type: object additionalProperties: false required: - inherits_membership properties: inherits_membership: type: boolean responses: '200': description: An updated block resource. content: application/json: schema: type: object required: - data properties: data: title: block type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block meta: type: - object - 'null' description: 'Optionally calculated block metadata which are not part of responses by default. ' additionalProperties: false properties: effective_category_type: type: - object - 'null' description: The Block resource's most immediate ancestor's Category Type. See documentation for Category Type for additional details. additionalProperties: false properties: id: type: string description: The Category Type's ID name: type: string description: The Category Type's display name description: type: - string - 'null' description: Optional additional descriptive text. deactivated_at: type: - string - 'null' format: date-time description: A flag indicating whether the category type is deactivated. effective_privacy: type: string enum: - whole_workspace - some_but_not_all description: 'The effective privacy of a resource is calculated based on all direct and inherited access. If a resource or any of its parents that it inherits access from are accessible to the entire workspace, the effective privacy is `whole_workspace`. Otherwise, the effective privacy is `some_but_not_all`. ' custom_fields: type: array description: "This metadata is available when requesting block resources from the\n`loupe/v3/blocks/{block_id}` `GET` endpoint.\n\nYou request that this metadata be included in responses with the `expose` query \nparameter like: `loupe/v3/blocks/{block_id}?expose[block][meta][custom_fields]`.\n\nEffective custom fields include both **directly assigned** and **inherited** fields from \nthe associated category type. Inherited fields may, or may not, have explicit \n`block_custom_field_value`s.\n\nThe result is a list of effective custom fields for the block. Can be empty or\ncontain multiple instances of any custom field type.\n\nOrdering:\n- Inherited custom fields appear first, ordered by the associated\n Category Type’s saved custom field order.\n- Directly assigned custom fields (via block_custom_field_values)\n follow, preserving their relative order as returned by the service.\n" items: type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - multiSelect - date - url - usersSelect description: The type of custom field. association_type: type: string description: Indicates whether the field is `direct` (explicitly assigned to the block) or `inherited` (comes from the category type). enum: - direct - inherited options: type: array description: Active options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: description: The value for this custom field. Can be null for fields that have no value set. oneOf: - title: Field Value type: object required: - id - value properties: id: type: string format: uuid description: The ID of the custom field value. value: oneOf: - title: Textarea Value type: object required: - value properties: value: type: - string - 'null' description: The text content. - title: Multi Select Value type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select Value type: object required: - id properties: id: type: - string - 'null' format: uuid description: The selected option ID. - title: Date Value type: object required: - value properties: value: type: - string - 'null' format: date-time description: The selected date. - title: URL Value type: object required: - url properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Optional display label for the URL. - title: Users Select Value type: object additionalProperties: false properties: user_ids: type: array description: List of selected user IDs. items: type: string format: uuid group_ids: type: array description: List of selected user group IDs. items: type: string format: uuid - title: 'Null' type: - object - 'null' enum: - null attributes: type: object required: - color - description - duration - title - start_at - row_index - y_scale - browsable - is_template - template_name - template_description - is_workspace_wide_template - created_at - updated_at additionalProperties: false properties: color: type: - string - 'null' description: A color applied to this block. Currently only supports hex values in the format of '#FFF' or '#FFFFFF'. description: type: - string - 'null' description: Text describing the block. Maximum length of 256 characters. title: type: string description: A descriptive name for the block. start_at: type: - string - 'null' description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the beginning of the span of time that this block resource represents. end_at: type: - string - 'null' deprecated: true description: 'DEPRECATED: migrate to `duration`. An ISO 8601-formatted (''YYYY-MM-DD'') date marking the end of the span of time that this block resource respresents. The start_at value must be a date ocurring before the end_at value.' duration: type: - string - 'null' description: 'An ISO 8601 duration string representing the length of time this block spans. Permitted formats: P{n}D (days), P{n}W (weeks), P{n}M (months). When a block has a start_at, the duration is always in days. Week and month units are only used for unscheduled blocks (start_at is null). Clients compute end_at as start_at + duration. ' row_index: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A 1-based value indicating its row position relative to other rows of blocks within their bounding parent, a Category. ' y_scale: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A value indicating how tall the block will be relative to the default size. ' browsable: type: boolean description: 'Whether this block shows up in the Plans Directory (and in the future, other directories). If false, the block is still accessible in the web application via any parent plans or connections or even by way of direct link. It just won''t show up in the Plans Directory. ' default: false created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true is_template: type: boolean readOnly: true description: 'Whether this block is a template that can be used to create new blocks. This field is read-only and cannot be set directly. Templates are created by duplicating an existing block with `is_template=true` via the block duplication endpoint. To remove a block from being a template, use the `delete` endpoint for Blocks. ' default: false is_workspace_wide_template: type: boolean description: 'Whether this template is available workspace-wide. When `true`, the template can be used across all plans in the workspace. When `false`, the template is only available within its origin plan. This field can only be set when `is_template` is `true`.' default: false template_name: type: - string - 'null' description: Display name for the template. Required when `is_template` is `true`. template_description: type: - string - 'null' description: Optional description of the template's purpose. relationships: type: object additionalProperties: false required: - creator - owner - rich_text_document - workspace properties: asset: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset boards: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board block_connectors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector category: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user owner: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user rich_text_document: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - rich_text_document workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace view: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view child_view: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value inherited_custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value paired_moment: allOf: - description: 'Only blocks of a type that supports moment pairing are allowed to have paired moments. Furthermore, this relationship is only writable when first creating a block and cannot be changed thereafter. If a block of a type that supports moment pairing is created without specifying a paired_moment, a new paired_moment is created for that block. **NOTE** that this relationship is currently [PROPOSED], not implemented. ' - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment meta: type: object properties: access: type: object description: 'Information about who has access to the given resource. This metadata is only available for single (non-batch) `GET` / `PATCH` / `POST` requests, and is not returned by default. Add `expose[meta][access]` to your query parameters to request it in the response body. ' additionalProperties: false required: - users - groups - resources properties: users: type: array description: 'A list of users that have access to this resource. These users have been given direct access; the list does not include all users who have access via a User Group or inherited resource. Each item in the list is a JSON:API Resource Identifier Object. All entries are `user`s. ' items: type: object additionalProperties: false required: - id - type properties: id: type: string format: uuid type: type: string enum: - user groups: type: array description: 'A list of groups that have access to this resource. These are all User Groups that have been created by an admin of the Opal ahead of time. Each item in the list is a JSON:API Resource Identifier Object. All entries are `user_group`s. Each user group''s name is surfaced as `meta.title` for convenience and each user group''s membership count (including all inherited membership) is surfaced as `meta.count`. ' items: type: object additionalProperties: false required: - id - type - meta properties: id: type: string format: uuid type: type: string enum: - user_group meta: type: object readOnly: true additionalProperties: false required: - title - count properties: title: type: string readOnly: true count: type: integer minimum: 0 readOnly: true resources: type: array description: 'A list of resources from which this resource _might_ inherit membership. The list always contains an entry for every other resource allowed to provide membership to the given resource. Look at the `meta.inherits_membership` property to determine if a given resource''s membership actually is being inherited. Each item in the list is a JSON:API Resource Identifier Object. Entries may have varying `types` but all resources can be retrieved separately from Opal API endpoints to get more information about them. Each resource''s name or title is surfaced as `meta.title` for convenience and each resource''s membership count (including all inherited membership) is surfaced as `meta.count`. ' items: type: object additionalProperties: false required: - id - type - meta properties: id: type: string format: uuid type: type: string meta: type: object additionalProperties: false required: - inherits_membership - title - count properties: inherits_membership: type: boolean title: type: string readOnly: true count: type: integer minimum: 0 readOnly: true included: type: array items: oneOf: - title: asset type: object required: - id - type - attributes - links - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset attributes: type: object required: - bytes - created_at - download_url_override - duration - file_extension - file_name - height - mime_type - updated_at - url - width additionalProperties: false properties: url: type: string download_url_override: type: - string - 'null' description: 'An alternative download URL for the file. If set, downloading the asset will result in a redirect to the overridden location instead of downloading the asset data directly. When not present, `url` should be used. ' width: type: - integer - 'null' description: When applicable, the width in pixels of an image or video. height: type: - integer - 'null' description: When applicable, the height in pixels of an image or video. duration: type: - integer - 'null' description: When applicable, the play time of a video in seconds. pages: type: - integer - 'null' description: When applicable, the number of pages in a PDF document. mime_type: type: string description: The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) that corresponds to the uploaded file. file_name: type: string file_extension: type: string bytes: type: integer description: The size of the file in bytes. created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true links: type: object additionalProperties: false required: - v2_request properties: v2_request: type: string format: uri relationships: required: - opal type: object additionalProperties: false properties: opal: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - opal - title: block type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block meta: type: - object - 'null' description: 'Optionally calculated block metadata which are not part of responses by default. ' additionalProperties: false properties: effective_category_type: type: - object - 'null' description: The Block resource's most immediate ancestor's Category Type. See documentation for Category Type for additional details. additionalProperties: false properties: id: type: string description: The Category Type's ID name: type: string description: The Category Type's display name description: type: - string - 'null' description: Optional additional descriptive text. deactivated_at: type: - string - 'null' format: date-time description: A flag indicating whether the category type is deactivated. effective_privacy: type: string enum: - whole_workspace - some_but_not_all description: 'The effective privacy of a resource is calculated based on all direct and inherited access. If a resource or any of its parents that it inherits access from are accessible to the entire workspace, the effective privacy is `whole_workspace`. Otherwise, the effective privacy is `some_but_not_all`. ' custom_fields: type: array description: "This metadata is available when requesting block resources from the\n`loupe/v3/blocks/{block_id}` `GET` endpoint.\n\nYou request that this metadata be included in responses with the `expose` query \nparameter like: `loupe/v3/blocks/{block_id}?expose[block][meta][custom_fields]`.\n\nEffective custom fields include both **directly assigned** and **inherited** fields from \nthe associated category type. Inherited fields may, or may not, have explicit \n`block_custom_field_value`s.\n\nThe result is a list of effective custom fields for the block. Can be empty or\ncontain multiple instances of any custom field type.\n\nOrdering:\n- Inherited custom fields appear first, ordered by the associated\n Category Type’s saved custom field order.\n- Directly assigned custom fields (via block_custom_field_values)\n follow, preserving their relative order as returned by the service.\n" items: type: object required: - id - display_name - type - options - deactivated_options - association_type - data additionalProperties: false properties: id: type: string format: uuid description: The ID of the custom field. display_name: type: string description: The display name for this custom field. type: type: string enum: - textarea - singleSelect - multiSelect - date - url - usersSelect description: The type of custom field. association_type: type: string description: Indicates whether the field is `direct` (explicitly assigned to the block) or `inherited` (comes from the category type). enum: - direct - inherited options: type: array description: Active options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer deactivated_options: type: array description: Deactivated options for this custom field (for select types). Empty array for non-select types. items: type: object required: - id - display_name - position properties: id: type: string format: uuid display_name: type: string position: type: integer data: description: The value for this custom field. Can be null for fields that have no value set. oneOf: - title: Field Value type: object required: - id - value properties: id: type: string format: uuid description: The ID of the custom field value. value: oneOf: - title: Textarea Value type: object required: - value properties: value: type: - string - 'null' description: The text content. - title: Multi Select Value type: object required: - ids properties: ids: type: array description: List of selected option IDs. items: type: string format: uuid - title: Single Select Value type: object required: - id properties: id: type: - string - 'null' format: uuid description: The selected option ID. - title: Date Value type: object required: - value properties: value: type: - string - 'null' format: date-time description: The selected date. - title: URL Value type: object required: - url properties: url: type: string format: uri description: The URL value. label: type: - string - 'null' description: Optional display label for the URL. - title: Users Select Value type: object additionalProperties: false properties: user_ids: type: array description: List of selected user IDs. items: type: string format: uuid group_ids: type: array description: List of selected user group IDs. items: type: string format: uuid - title: 'Null' type: - object - 'null' enum: - null attributes: type: object required: - color - description - duration - title - start_at - row_index - y_scale - browsable - is_template - template_name - template_description - is_workspace_wide_template - created_at - updated_at additionalProperties: false properties: color: type: - string - 'null' description: A color applied to this block. Currently only supports hex values in the format of '#FFF' or '#FFFFFF'. description: type: - string - 'null' description: Text describing the block. Maximum length of 256 characters. title: type: string description: A descriptive name for the block. start_at: type: - string - 'null' description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the beginning of the span of time that this block resource represents. end_at: type: - string - 'null' deprecated: true description: 'DEPRECATED: migrate to `duration`. An ISO 8601-formatted (''YYYY-MM-DD'') date marking the end of the span of time that this block resource respresents. The start_at value must be a date ocurring before the end_at value.' duration: type: - string - 'null' description: 'An ISO 8601 duration string representing the length of time this block spans. Permitted formats: P{n}D (days), P{n}W (weeks), P{n}M (months). When a block has a start_at, the duration is always in days. Week and month units are only used for unscheduled blocks (start_at is null). Clients compute end_at as start_at + duration. ' row_index: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A 1-based value indicating its row position relative to other rows of blocks within their bounding parent, a Category. ' y_scale: type: integer deprecated: true description: 'This attribute has been deprecated, and should now be found on the related BlockConnector resource. A value indicating how tall the block will be relative to the default size. ' browsable: type: boolean description: 'Whether this block shows up in the Plans Directory (and in the future, other directories). If false, the block is still accessible in the web application via any parent plans or connections or even by way of direct link. It just won''t show up in the Plans Directory. ' default: false created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true is_template: type: boolean readOnly: true description: 'Whether this block is a template that can be used to create new blocks. This field is read-only and cannot be set directly. Templates are created by duplicating an existing block with `is_template=true` via the block duplication endpoint. To remove a block from being a template, use the `delete` endpoint for Blocks. ' default: false is_workspace_wide_template: type: boolean description: 'Whether this template is available workspace-wide. When `true`, the template can be used across all plans in the workspace. When `false`, the template is only available within its origin plan. This field can only be set when `is_template` is `true`.' default: false template_name: type: - string - 'null' description: Display name for the template. Required when `is_template` is `true`. template_description: type: - string - 'null' description: Optional description of the template's purpose. relationships: type: object additionalProperties: false required: - creator - owner - rich_text_document - workspace properties: asset: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset boards: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board block_connectors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector category: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user owner: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user rich_text_document: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - rich_text_document workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace view: deprecated: true type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view child_view: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value inherited_custom_field_values: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_custom_field_value paired_moment: allOf: - description: 'Only blocks of a type that supports moment pairing are allowed to have paired moments. Furthermore, this relationship is only writable when first creating a block and cannot be changed thereafter. If a block of a type that supports moment pairing is created without specifying a paired_moment, a new paired_moment is created for that block. **NOTE** that this relationship is currently [PROPOSED], not implemented. ' - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment - title: block_connector type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector attributes: type: object required: - row_index - y_scale - created_at - updated_at additionalProperties: false properties: row_index: type: integer description: A 1-based value indicating the connected block's row position relative to other rows of blocks within their bounding parent, a Category. y_scale: type: integer description: A value indicating how tall the block will be relative to the default size specified in the Category. created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - block - view additionalProperties: false properties: block: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view category: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category - title: board type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board attributes: type: object required: - created_at - description - is_public - is_archived - title - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the board. is_public: type: boolean description: 'Indicates whether or not a board and all of its contents are visible to users in the workspace. Unless otherwise specified, this value is `false` by default. Boards are always visible to the user that created them. ' is_archived: type: boolean description: 'Indicates whether or not a board has been archived. If set to `true`, the UI will only display the board in the ‘Archived Boards’ view. If set to `false` (the default), the board may be displayed in other views, depending on the user’s filter settings. ' title: type: string description: The name of the board. updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object additionalProperties: false required: - created_by_user - workspace properties: asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference board_collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_collaborator board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user object_collections: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace board_columns: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_column board_user_setting: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_user_setting default_story: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - story - title: category type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category attributes: type: object required: - title - position - block_size - view_mode - group_by_strategy - group_by_exclude_empty_groupings - depth - is_supportive - created_at - updated_at additionalProperties: false properties: title: type: string description: A descriptive name for the category. depth: type: integer readOnly: true description: This is a read-only calculated field. Given that a category can have a parent category, depth is a zero-based indication of how far removed this category is from the root category. position: type: integer description: A zero-based value indicating its position relative to other categories at the same depth. block_size: type: string description: An enumeration representing the sizes of block resources within the category. enum: - small - medium - large view_mode: type: string description: An enumeration representing the display mode of the category. enum: - default - condensed group_by_strategy: type: - string - 'null' description: 'An enumeration representing the grouping strategy of a category, part of instructions to the client on how children within the category should be displayed. If set to `custom_field`, then the the `group_by_custom_field` relationship must also be provided. ' enum: - null - category_type - custom_field group_by_exclude_empty_groupings: type: boolean default: true description: 'Part of instructions to the client on how children within the category should be displayed. Inidicates whether groupings that are empty should be hidden from view. Defaults to true. ' is_supportive: type: boolean default: false description: 'Indicates that the category contains blocks native to other views, and that the blocks within are here "in support of" this category''s view. Categories with this attribute set to `true` are created internally by the system, and cannot be edited. ' readOnly: true created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true relationships: type: object additionalProperties: false required: - block_connectors - blocks - charts - creator - view properties: block_template: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block block_connectors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block_connector blocks: deprecated: true description: 'Reading blocks directly through the category has been deprecated in favor of reading block_connectors. ' type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type charts: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - chart creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user filter_set: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - filter_set group_by_custom_field: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field parent_category: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view meta: type: object required: - effective_category_type_id properties: effective_category_type_id: type: - string - 'null' format: uuid description: 'The id of the “effective” `category_type` relationship for this `category` resource, as described in [the Categories overview](/api/documentation/v3#tag/Categories).' readOnly: true - title: category_type type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type attributes: type: object required: - created_at - name - supported_paired_type additionalProperties: false properties: name: type: string description: The name that will be displayed in the Opal application UI. description: type: - string - 'null' description: A description of the record. supported_paired_type: type: - string - 'null' default: null enum: - moment - null description: Whether blocks of this type will have resources of the given type paired with them. Moment pairing allows teams to work with the same resources from the Plan (via blocks) or from a Board or Calendar (via Moments). Once set to 'moment', this property cannot be set back to null. Blocks created with a type that supports moment pairing will always have paired moments. Conversely, blocks created with types that do not support moment pairing will not have paired moments (unless moment pairing support is added to the type later). created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true deactivated_at: type: - string - 'null' format: date-time description: An RFC 3339 date-time. If present, indicates the record has been deactivated (but not deleted). has_explicit_custom_field_order: type: boolean default: false description: 'If true, the category type uses its own saved order for `custom_fields`. If false, ordering falls back to the global custom field order (e.g., `custom_fields.created_at`). ' relationships: type: object required: - creator - workspace - in_support_of_category_types additionalProperties: false properties: creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace custom_fields: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field default_child_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type in_support_of_category_types: description: 'A list of category_types that this type is configured to support. ' type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type - title: key_date type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - key_date attributes: type: object required: - title - color - start_date - end_date - created_at - updated_at additionalProperties: false properties: title: type: string description: A descriptive name for the key event or date. color: type: - string - 'null' description: A color for this key date. The value must be in hex format, such as '#FFF' or '#FFFFFF'. start_date: type: string description: The start of the period, represented as an ISO 8601-formatted ('YYYY-MM-DD') date, when this key event or date begins to be observed. A single-day event can be represented with a start_date and a null end_date. end_date: type: - string - 'null' description: The end of the period, represented as an ISO 8601-formatted ('YYYY-MM-DD') date, when this key event or date ceases to be observed. created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true relationships: type: object additionalProperties: false required: - view properties: view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view - title: view type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view meta: type: - object - 'null' description: 'Optionally calculated view metadata which are not part of responses by default. ' additionalProperties: false properties: effective_privacy: type: string enum: - whole_workspace - some_but_not_all description: 'The effective privacy of a resource is calculated based on all direct and inherited access. If a resource or any of its parents that it inherits access from are accessible to the entire workspace, the effective privacy is `whole_workspace`. Otherwise, the effective privacy is `some_but_not_all`. ' attributes: type: object required: - title - kind - start_at - end_at - description - default_timescale - created_at - updated_at - start_month_index - start_weekday_index - show_smart_swimlane_datasource - swimlane_title_column_width additionalProperties: false properties: title: type: string description: A descriptive name for the view. description: type: - string - 'null' description: A field allowing for additional descriptive text. kind: type: string description: An enumeration representing the view type. Currently only supports Plan views. enum: - plan default_timescale: type: string description: An enumeration representing the timescale of this view. enum: - day - week - month - quarter start_at: type: string description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the beginning of the span of time that this view resource respresents. The start_at value must be a date ocurring before the end_at value. end_at: type: string description: An ISO 8601-formatted ('YYYY-MM-DD') date marking the end of the span of time that this view resource respresents. The start_at value must be a date ocurring before the end_at value. created_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. readOnly: true updated_at: type: string format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. readOnly: true start_month_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 description: Start month index for the plan. Specifies the number of months, 0 to 11, to offset from January. 0 by default, meaning no offset. If set, e.g., 1, start in February. start_weekday_index: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 description: Start weekday index for the plan. Specifies the days in a week, 0 to 6 (Sunday to Saturday). 0 (Sunday) is the default. If set to, e.g., 1, weeks will start on Monday. show_smart_swimlane_datasource: type: boolean description: Whether to display the datasource filter information on smart swimlanes. Defaults to true. swimlane_title_column_width: type: integer description: The width in pixels of the swimlane title column from 200 to 800 for persistence across sessions. Defaults to 200. relationships: type: object additionalProperties: false required: - categories - blocks - owner - creator - workspace - colors - key_dates - parent_block properties: categories: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category category_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - category_type blocks: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block owner: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace colors: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view_color key_dates: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - key_date parent_block: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - block - title: view_color type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view_color attributes: type: object required: - label - color - created_at - updated_at additionalProperties: false properties: label: type: - string - 'null' description: A descriptive name for the color. color: type: string description: A color in hex format. Currently only supports hex values in the format of '#FFF' or '#FFFFFF'. created_at: type: string readOnly: true format: date-time description: An ISO 8601-formatted datetime indicating when the resource was created. updated_at: type: string readOnly: true format: date-time description: An ISO 8601-formatted datetime indicating when the resource was last updated. relationships: type: object additionalProperties: false required: - view properties: view: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - view example: data: id: f649cebe-3dce-441a-8335-86707303c388 type: block attributes: color: '#00FFFF' description: Just kidding, it's always time for coffee. title: Time For Coffee start_at: '2024-01-01' end_at: '2024-12-31' duration: P364D row_index: 1 y_scale: 1 is_template: false is_workspace_wide_template: false browsable: false template_name: null template_description: null created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' relationships: workspace: data: id: a897cb4c-12d3-446f-9621-ff388650d43a type: workspace view: data: id: c3f80757-c0ea-422c-aa51-3c9ef8e11a76 type: view category: data: id: 24b4dd04-e56a-4794-95fa-ea0a0709b5a6 type: category rich_text_document: data: id: 0f8d6b6f-0b32-404d-9d81-7864c3969ac0 type: rich_text_document asset: data: id: 48517d52-3a25-4ca6-a7f5-55a3817fc00f type: asset block_connectors: data: - id: 4cda51c0-3d53-44fe-8bd5-0b294ed1fe78 type: block_connector boards: data: - id: d19806fe-55b3-4682-9d67-07343fea3975 type: board creator: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user owner: data: id: ada0d59f-9f8c-4df3-ae9c-d6997ab48645 type: user child_view: data: id: e01b9a23-01f4-447d-96fd-03188fc9edd1 type: view custom_field_values: data: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 type: block_custom_field_value - id: b2c3d4e5-f6g7-8901-bcde-f23456789012 type: block_custom_field_value inherited_custom_field_values: data: - id: f597cbaa-c10c-4538-8bcf-6c2dadacb727 type: block_custom_field_value '400': description: Bad request content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '401': description: Unauthorized content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '403': description: Forbidden content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '404': description: Not found content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '409': description: Conflict content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '422': description: Unprocessable entity content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '500': description: "May also contain a `code` indicating additional context:\n\n- \"access_read_failed\": The operation completed successfully, but the\n server encountered an error reading access metadata. The resource\n may still be readable.\n" content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status delete: tags: - Blocks operationId: DeleteBlockV3 x-Operation-ID: DeleteBlockV3 summary: Delete a Block by the given ID description: 'This operation will also delete the block''s child view, if one is associated. You must also have permission to delete the child view. ' security: - oauth2: - offline_access - api_key: [] parameters: - name: block_id in: path required: true description: The ID of the Block. schema: type: string format: uuid responses: '204': description: The Block was successfully deleted. '403': description: Forbidden content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status '404': description: Not found content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string description: The http status code of the error response. title: type: string description: A short, human-readable summary of the error. detail: type: string description: A human-readable explanation of the error. code: type: string description: 'An system-readable error code to provide additional specificity for the error. ' required: - status servers: - url: https://login.ouropal.com components: securitySchemes: api_key: type: apiKey description: (Deprecated) This API also supports authentication via an API or session token set in the request headers. in: header name: Session-Token oauth2: type: oauth2 description: 'This API uses OAuth 2.0 with the authorization code grant flow. You can find more detailed authentication instructions in the [Authentication Strategies](/api/documentation#section/Authentication-Strategies/OAuth-2.0) section. ' flows: authorizationCode: authorizationUrl: /oauth2/auth tokenUrl: /oauth2/token scopes: offline_access: Include this scope if you wish to receive a refresh token anonymous_oauth: type: oauth2 description: 'The OAuth 2.0 client credentials flow is used for secure server-server requests when Opal does not need to associate a request with a particular Opal user. These anonymous requests are instead authorized based on the OAuth scope. ' flows: clientCredentials: tokenUrl: /oauth/token scopes: write:onboarding: Include this scope if you wish to make API requests to onboard new Opals. presentation_share_cookie: type: apiKey description: 'A cookie set and read by the Monolith service that authorizes a non-opal user to view a presentation and the resources within it. Other services can rely on this cookie by asking Monolith to authenticate it. ' in: cookie name: share_token x-refined-from: - opal-asgard-bff-openapi.yml - opal-v3-openapi.yml x-tagGroups: - name: ⚠️ Unstable tags: - Plans - Blocks - Custom Fields - name: ℹ️ Proposed tags: - Moments - Smart Blocks - In Market - name: 🔮 Experimental tags: - Experimental