openapi: 3.2.0 info: version: 3.0.0 title: Opal API (⚠️ WIP) Categories API license: name: Opal API License url: https://www.workwithopal.com/api-license description: "The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [BCP 14](https://tools.ietf.org/html/bcp14) [[RFC2119](https://tools.ietf.org/html/rfc2119)] [[RFC8174](https://tools.ietf.org/html/rfc8174)] when, and only when, they appear in all capitals, as shown here.\n\n# Other API Versions\n\nThe [v2 API](/api/documentation/v2) is more complete than the v3 API. Currently, if a resource has endpoints in both the v2 API and the v3 API you **SHOULD** use the v2 API endpoints. At some point in the future we will recommend the v3 API instead.\n\n*Note:* Endpoints will be added to the v3 API as needed, and we will continue to support all v2 API endpoints in the “JSON:API” and “Other” categories, even if we add an equivalent v3 API endpoint.\n\n# Key differences between v2 and v3 APIs\n\n## Resource Identifiers\n\nThe v3 API uses a different format for primary resource identifiers than the v2 API. Responses from v3 API endpoints include the resource’s v2 API id in the `attributes.legacy_id` field, in case you need to use both API versions. (v2 API resource identifiers are generally integers, but v2 API endpoints **MAY** use a different format.)\n\n*Note:* These are opaque strings, and you **MUST NOT** rely on the structure. Currently newly-created resources have a UUIDv4 identifier, but this behavior **MAY** change at any time. Existing identifiers will not be affected.\n\n# Documentation Organization\n\nv3 API endpoints are categorized by stability:\n\n1. Stable\n2. Unstable\n3. Proposed\n4. Experimental\n\nAll v3 API endpoints are [JSON:API](https://jsonapi.org)-compliant ([specification](https://jsonapi.org/format/)) and can be used with any [JSON:API-compliant client](https://jsonapi.org/implementations/).\n\nYour requests **MUST** set the `Accept` HTTP header to `application/vnd.api+json`. The server response’s `Content-Type` HTTP header will also be `application/vnd.api+json`.\n\n## Unstable Endpoints\n\n*Note:* This generally refers resources in the “Unstable” category, but includes endpoints with a summary that’s prefixed by `[UNSTABLE]`. These `[UNSTABLE]` endpoints may be part of a “Stable” resource.\n\nThe data structure and behavior of “Unstable” endpoints are not guaranteed, and we **MAY** change them at any time. You **MUST NOT** use these endpoints for production features, but **MAY** use them as a preview of upcoming features, and we welcome feedback.\n\n## Proposed Endpoints\n\n“Proposed” endpoints **MUST NOT** be used (they’re not yet implemented), and we **MAY** change or remove them at any time. We publish them at our discretion to share our plans and encourage internal feedback. We also welcome your feedback.\n\n# Design Principles\n\n## Breaking Changes\n\nWe **MAY** expand the data for “Stable” resources, but will not change or remove existing attributes or relationships for these resources. These expansions should not require any changes to your code.\n\nWe provide no guarantees for “Unstable,” \"Experimental,\" or “Proposed” endpoints.\n\n## Firehose Rule\n\nBy default endpoints include all the relevant data that’s accessible to the authenticated user. Clients **MAY** specify filters, ordering, pagination, sparse fields, and other limiting mechanisms to pare down the desired data.\n\n*Note:* Existing endpoints **MAY NOT** follow this maximalist approach, but new endpoints will, and we **MAY** enhance existing endpoints.\n\n## Obscurity\n\nIn order to provide customers with as much privacy as possible, many API calls that fail authorization will return `404 Not Found` rather than `403 Forbidden`. Do not design frontends around the expectation that a `404 Not Found` status code means a resource would not be returned given different authentication credentials.\n\n# Authentication Strategies\n## OAuth 2.0\nOpal uses OAuth 2.0 (https://oauth.net/2) to authenticate users and grant access to protected resources. After registering your application as an OAuth client, you must get permission from each user before accessing their account.\n\nThe main steps are:\n\n1. Register your application\n2. Direct the user to Opal, to authorize your application\n3. Opal confirm's user identity, and asks the user to grant your application permissions\n4. Opal issues tokens your application can use to access the user's Opal resources\n5. Your application can begin making requests to the Opal API on behalf of the user\n\n### Roles\n#### Client\nThe 3rd-party application accessing the API on behalf of the User.\n\n#### API\nAPI endpoints used to interact with a User's resources in Opal.\n\n#### User\nThe person authorizing the Client to access to their Opal account.\n\n### Registering your application\nApplication registration is currently a manual process.\n\nTo begin, you will need to provide the following information to the Opal integrations team:\n\n- Application name\n- Logo URI\n- Redirect URI\n\nIn return, expect to receive:\n\n- Client ID\n - public\n- Application secret\n - keep this private\n - keep this written down someplace safe. Opal cannot retrieve this for you if it is lost.\n\n### Authorization\nFor a Client to make API requests on behalf of Users, the User must first give consent.\nHere is an overview of the consent flow:\n\n1. Direct the User to grant access in Opal\n\n```\nhttps://login.ouropal.com/oauth2/auth?grant_type=authorization_code&scope=offline_access&response_type=code&client_id={client_id}&state={state}&redirect_uri={url_encoded_redirect}\n```\n\nParameters:\n- `client_id`: Provided by Opal.\n- `grant_type`: Set the value to authorization_code to receive a code string that can be exchanged for an access token.\n- `redirect_uri`: Defined by Client. After authentication, the user will be directed to this location.\n- `response_type`: The value code should be set for refresh tokens to be issued.\n- `scope`: The value offline_access must be present if you wish to use refresh tokens.\n- `state`: Defined by the Client. A unique value used to validate the response.\n\n\n2. If logged out, User is directed to log in to Opal\n\n3. User is redirected to consent page (if the User has not already given consent)\n\n```\nhttps://login.ouropal.com/oauth2/consent?consent_challenge=abc123\n```\n\n4. If the User grants permission, User is sent to the specified `redirect_uri`\n\n```\nhttps://example.com/defined-by-client?code=Mu9z2DndN7TfXSLaf99O8ReqqXqMabXhSqP5e0jlx_Q.naLKbko-GyfPJRGYcWyclxU0sBGwygPy05OSFww0XZ8&scope=offline_access&state={state}\n```\n\nParameters:\n- `code`: The Client may use this to get an access token.\n- `scope`: API permissions granted to the Client by the User.\n- `state`: The validation string provided by the Client in step 1.\n\nIf the User declines the consent prompt, User will be sent to the same `redirect_uri`, but with an error parameter :\n\n```\nhttps://example.com/defined-by-client?error=consent+request+denied&state={state}\n```\n\nParameters:\n- `error`: A brief description of the issue.\n- `state`: The validation string provided by the Client in step 1.\n\n### Retrieving Access Token\nYou must make a POST request to the token endpoint to get an access token, before the code expires:\n\n```\ncurl -X POST \\\n https://login.ouropal.com/oauth2/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -d 'code={code}&client_id={client_id}&redirect_uri={url_encoded_redirect}&client_secret={client_secret}&grant_type=authorization_code'\n```\n\nParameters:\n- `code`\n- `client_id`: Client ID provided by Opal.\n- `client_secret`: Client secret provided by Opal.\n- `grant_type`: Set value to authorization_code .\n- `redirect_uri`: Optional.\n\nIf successful, a JSON-formatted response body will contain the access_token and refresh_token:\n\n```json\n{\n \"access_token\":\"ABC123\",\n \"token_type\":\"bearer\",\n \"expires_in\":3600,\n \"refresh_token\":\"DEF456\",\n \"scope\":\"offline_access\"\n}\n```\n\n### Refreshing an Access Token\nOnce the access_token expires, you may generate a new one at the same token endpoint, but with different parameters.\nNote that in this request, a \"refresh_token\" parameter is used instead of \"code\", and the \"grant_type\" value is now \"refresh_token\" instead of \"authorization_code\".\n\n```\ncurl -X POST \\\n https://login.ouropal.com/oauth2/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -d 'refresh_token={refresh_token}&client_id={client_id}&redirect_uri={url_encoded_redirect}&client_secret={secret}&grant_type=refresh_token'\n```\n\nParameters:\n- `client_id`: Client ID provided by Opal.\n- `client_secret`: Client secret provided by Opal.\n- `grant_type`: Set value to refresh_token .\n- `redirect_uri`: Optional.\n- `refresh_token`: Refresh token value\n\n### Making Authenticated Requests\n\nSet an authorization header in your requests, specifying your access token as documented here: https://tools.ietf.org/html/rfc6750#section-2.1.\n\n**NOTE** that the `Authorization` header supercedes the `Session-Token` header described in the documentation for many endpoints. Specifying an `Authorization` header means you do not need to specify a `Session-Token` header.\n\n```\nAuthorization: Bearer ACCESS_TOKEN\n```\n\nFor example:\n```\n GET /resource HTTP/1.1\n Host: server.example.com\n Authorization: Bearer mF_9.B5f-4.1JqM\n```\n\n### Client Revoke/Rolling OAuth secrets\nClient secrets must be kept secret and not exposed outside of the token retrieval requests. If a secret has been potentially compromised, please notify Opal as soon as possible and let us know the OAuth client id associated with the secret. We will roll/update the secret, which will invalidate all existing access and refresh tokens. Invalidating tokens will cause users to need to reauthenticate, but consent should be remembered.\n" servers: - url: https://login.ouropal.com tags: - name: Categories description: "## Overview\n\nCategories are in a tree: a given category has zero or more ancestors and zero or more descendants. The tree is built by recursively following `parent_category` relationships. Currently our trees are at most two nodes deep (that is, a root with zero or more leaves), but clients **MUST** be able to handle trees of any depth.\n\n### Category type and custom fields\n\nCategories can be associated with [Category Types](/api/documentation/v3#tag/Category-Types), determining which [Custom Fields](/api/documentation/v3#tag/Custom-Fields) are available to [Blocks](/api/documentation/v3#tag/Blocks) in the category. If the category has a relationship with a deactivated category type it is considered to have no category type.\n\n### Effective category type\n\nThe effective category type allows the category to inherit a category type relationship.\n\n*Note:* The following description of the algorithm is informational: clients that want the effective category type **MUST** use the `effective_category_type_id` property in the category resource object’s `meta` information, and **MUST NOT** manually compute the value using this algorithm, as the exact behavior may change without warning.\n\nIf the given category has a relationship with an active (not deactivated, not deleted) category type that is the effective category type.\n\nIf the given category does *not* have a relationship with an active category type, any ancestors that have a relationship with an active category type are selected, and the nearest ancestor (the ancestor with the largest `depth`) provides the effective category type.\n\nIf the given category has no ancestors, or none of its ancestors have a relationship with an active category type, *and* the view *does* have a relationship to an active category type, the view’s category type is the effective category type.\n\nIf none of the above conditions are met, the category does not have an effective category type.\n\n*Note*: The behavior doesn’t change based on where the given category is in the tree — the logic is the same for the root, leaves, and everything in-between. This is why the following table refers to ‘parent’ and ‘grandparent’, rather than using tree terminology.\n\nIn the following\n* ‘✓’ means the column’s entry is associated to an active category type\n* the parent and grandparent demonstrate inheritance behavior if the given category has ancestors\n with an associated active category type\n\n | view | grandparent category | parent category | given category | effective category type comes from… |\n | :----: | :--------------------: | :---------------: | :--------------: | -------------------- |\n | | | | ✓ | given |\n | | | ✓ | ✓ | given |\n | | ✓ | | ✓ | given |\n | ✓ | | | ✓ | given |\n | | | ✓ | | parent |\n | | ✓ | ✓ | | parent |\n |✓ | | ✓ | | parent |\n | | ✓ | | | grandparent |\n | ✓ | ✓ | | | grandparent |\n | ✓ | | | | view |\n | | | | | \U0001F6AB (no category type) |\n" paths: /loupe/v3/categories: post: tags: - Categories operationId: CreateCategoryV3 summary: Create a new Category 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: - block_template - block_connectors - block_connectors.block - blocks - category_type - filter_set - group_by_custom_field - view style: form explode: false requestBody: content: application/json: schema: type: object required: - data properties: data: type: object required: - type - attributes - relationships properties: type: type: string enum: - category attributes: type: object required: - title - position additionalProperties: false properties: title: type: - string - 'null' description: A descriptive name for the category. position: type: integer description: A zero-based value indicating its position relative to other categories at the same depth. block_size: type: string default: small description: An enumeration representing the sizes of block resources within the category. enum: - small - medium - large view_mode: type: string default: default 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: - 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. ' relationships: type: object additionalProperties: false required: - 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 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 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 responses: '201': description: A newly created category resource. content: application/json: schema: type: object required: - data properties: data: 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 included: type: array items: oneOf: - 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: 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: custom_field type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field attributes: type: object required: - description - display_name - is_deactivated - is_color_disabled - is_cascading - is_system_generated - metadata - created_at - updated_at additionalProperties: false properties: display_name: type: string description: 'The display name which will appear in the Opal application UI where used. ' description: type: - string - 'null' description: A plain text description of the custom field. is_deactivated: type: boolean description: 'A true/false value indicating whether this custom field is available for use within the Opal application. Note that this is separate from deleting the custom field. ' is_color_disabled: type: boolean description: 'Controls whether color relationships defined on options are displayed in the UI. When true, colors are hidden without removing the underlying color relationship settings. ' is_cascading: type: boolean description: 'PROPOSED: Indicates if blocks whose block_type has this custom_field enabled will inherit the values set for this custom field from its nearest ancestor block. Setting explicit values for this custom_field on a block will override inherited values. ' is_system_generated: type: boolean default: false readOnly: true description: 'Whether this field was auto-generated by the system rather than created by a user. Such fields currently cannot be renamed or deleted, though this may change in the future. Relevant for fields like the ‘Status’ single-select.' metadata: type: - object - 'null' deprecated: true description: 'You **SHOULD NOT** read this data. Instead, you **SHOULD** add `active_options` (and, if relevant, `deleted_options`) to the `custom_fields` request’s `include` query, and use the included `custom_field_option` resources. Explanation: serializing a few attributes from relationships in the `metadata` attribute was convenient for internal use while the `custom_field` resource was in development, but it’s not compliant with JSON:API, and the `include` approach is superior anyhow as allows callers full control over what data is included. `metadata/options` also has a different implementation than `custom_field_option` resources, so there’s some risk the two representations will become inconsistent.' oneOf: - title: Empty Object type: - object - 'null' additionalProperties: false description: 'The empty object for custom fields based on custom field types which have no configurable settings. ' - title: Single Select Metadata (V1) type: object required: - options properties: options: type: array items: type: object required: - id - display_name - position properties: id: type: string description: The ID of the option. Must be globally unique and a UUID. display_name: type: string description: The display value for this option. Must be unique across non-deleted siblings. position: type: integer description: The ordinal position of this option. Must be unique across non-deleted siblings. deleted_at: type: - string - 'null' format: date-time description: 'An ISO8601 date-time value, which will remove the given option from being usable. Once an option is created, it cannot be outright removed from the system. Instead, it can be deactivated by setting this value to a date-time value. One can set this to a value to remove the option from being usable, or null to restore it and make it usable again. Note that setting this to null will only be successful if doing so does not clobber the position or name of another non-deleted sibling. ' relationships: type: object additionalProperties: false properties: custom_field_color: allOf: - 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_color description: 'A relationship to a color for this option. Can be omitted (no color), included with null data (explicitly no color), or included with valid color data. ' paired_label: allOf: - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label description: 'A relationship to a label that’s been paired with this option. ' created_at: type: string format: date-time description: An ISO8601 date-time representing the entity's creation date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time representing the entity's most recent updated date-time. readOnly: true relationships: type: object required: - custom_field_type - workspace - active_options - deleted_options - creator additionalProperties: false properties: active_options: 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_option deleted_options: 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_option custom_field_type: 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: - custom_field_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 paired_label_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: - label_set 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 - title: filter_set type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - filter_set attributes: type: object required: - resource_type - filter - created_at - updated_at - deleted_at additionalProperties: false properties: resource_type: type: string enum: - block filter: type: object additionalProperties: false properties: plan_ids: type: array items: type: string format: uuid grandparent_plan_ids: type: array items: type: string format: uuid custom_fields: type: object additionalProperties: oneOf: - type: array items: type: string format: uuid - type: object additionalProperties: false required: - user_ids - group_ids properties: user_ids: type: array items: type: string format: uuid group_ids: type: array items: type: string format: uuid created_at: type: string format: date-time description: An ISO8601 date-time representing the entity's creation date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time representing the entity's most recent updated date-time. readOnly: true deleted_at: type: - string - 'null' format: date-time description: An ISO8601 date-time representing the entity's deletion date-time. readOnly: true relationships: type: object required: - creator - workspace 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 - 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 example: data: id: f649cebe-3dce-441a-8335-86707303c388 type: category attributes: title: Time For Coffee depth: 0 position: 0 block_size: medium view_mode: default group_by_strategy: null group_by_exclude_empty_groupings: true is_supportive: false created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' relationships: view: data: id: c3f80757-c0ea-422c-aa51-3c9ef8e11a76 type: view block_connectors: data: - id: 48517d52-3a25-4ca6-a7f5-55a3817fc00f type: block_connector blocks: data: - id: 24b4dd04-e56a-4794-95fa-ea0a0709b5a6 type: block category_type: data: null charts: data: [] creator: data: id: 61876808-5d57-455d-ba52-4ded14070b4b type: user filter_set: data: null group_by_custom_field: data: null parent_category: data: id: 10f0c22d-572c-4310-8849-9bcbe7f440ad type: category meta: effective_category_type_id: b69138d6-be91-44f7-b6ef-6e9c5abed51d '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: Internal Server Error 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 /loupe/v3/categories/{category_id}: get: tags: - Categories operationId: ReadCategoryV3 summary: Get a Category by the given ID security: - oauth2: - offline_access - api_key: [] parameters: - name: category_id in: path required: true description: The ID of the Category. schema: type: string format: uuid - name: expose in: query required: false description: Expose response data that is only provided by request. schema: type: object properties: effective_category_type_id: type: string format: uuid description: 'Exposes the id of the “effective” `category_type` relationship for this `category` resource, as described in [the Categories overview](/api/documentation/v3#tag/Categories). ' - name: include in: query required: false description: A comma separated value of related objects to include. schema: type: array items: type: string enum: - block_template - block_connectors - block_connectors.block - blocks - category_type - filter_set - group_by_custom_field - view style: form explode: false responses: '200': description: The requested Category content: application/json: schema: type: object required: - data properties: data: 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 included: type: array items: oneOf: - 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: 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: custom_field type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field attributes: type: object required: - description - display_name - is_deactivated - is_color_disabled - is_cascading - is_system_generated - metadata - created_at - updated_at additionalProperties: false properties: display_name: type: string description: 'The display name which will appear in the Opal application UI where used. ' description: type: - string - 'null' description: A plain text description of the custom field. is_deactivated: type: boolean description: 'A true/false value indicating whether this custom field is available for use within the Opal application. Note that this is separate from deleting the custom field. ' is_color_disabled: type: boolean description: 'Controls whether color relationships defined on options are displayed in the UI. When true, colors are hidden without removing the underlying color relationship settings. ' is_cascading: type: boolean description: 'PROPOSED: Indicates if blocks whose block_type has this custom_field enabled will inherit the values set for this custom field from its nearest ancestor block. Setting explicit values for this custom_field on a block will override inherited values. ' is_system_generated: type: boolean default: false readOnly: true description: 'Whether this field was auto-generated by the system rather than created by a user. Such fields currently cannot be renamed or deleted, though this may change in the future. Relevant for fields like the ‘Status’ single-select.' metadata: type: - object - 'null' deprecated: true description: 'You **SHOULD NOT** read this data. Instead, you **SHOULD** add `active_options` (and, if relevant, `deleted_options`) to the `custom_fields` request’s `include` query, and use the included `custom_field_option` resources. Explanation: serializing a few attributes from relationships in the `metadata` attribute was convenient for internal use while the `custom_field` resource was in development, but it’s not compliant with JSON:API, and the `include` approach is superior anyhow as allows callers full control over what data is included. `metadata/options` also has a different implementation than `custom_field_option` resources, so there’s some risk the two representations will become inconsistent.' oneOf: - title: Empty Object type: - object - 'null' additionalProperties: false description: 'The empty object for custom fields based on custom field types which have no configurable settings. ' - title: Single Select Metadata (V1) type: object required: - options properties: options: type: array items: type: object required: - id - display_name - position properties: id: type: string description: The ID of the option. Must be globally unique and a UUID. display_name: type: string description: The display value for this option. Must be unique across non-deleted siblings. position: type: integer description: The ordinal position of this option. Must be unique across non-deleted siblings. deleted_at: type: - string - 'null' format: date-time description: 'An ISO8601 date-time value, which will remove the given option from being usable. Once an option is created, it cannot be outright removed from the system. Instead, it can be deactivated by setting this value to a date-time value. One can set this to a value to remove the option from being usable, or null to restore it and make it usable again. Note that setting this to null will only be successful if doing so does not clobber the position or name of another non-deleted sibling. ' relationships: type: object additionalProperties: false properties: custom_field_color: allOf: - 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_color description: 'A relationship to a color for this option. Can be omitted (no color), included with null data (explicitly no color), or included with valid color data. ' paired_label: allOf: - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label description: 'A relationship to a label that’s been paired with this option. ' created_at: type: string format: date-time description: An ISO8601 date-time representing the entity's creation date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time representing the entity's most recent updated date-time. readOnly: true relationships: type: object required: - custom_field_type - workspace - active_options - deleted_options - creator additionalProperties: false properties: active_options: 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_option deleted_options: 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_option custom_field_type: 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: - custom_field_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 paired_label_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: - label_set 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 - title: filter_set type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - filter_set attributes: type: object required: - resource_type - filter - created_at - updated_at - deleted_at additionalProperties: false properties: resource_type: type: string enum: - block filter: type: object additionalProperties: false properties: plan_ids: type: array items: type: string format: uuid grandparent_plan_ids: type: array items: type: string format: uuid custom_fields: type: object additionalProperties: oneOf: - type: array items: type: string format: uuid - type: object additionalProperties: false required: - user_ids - group_ids properties: user_ids: type: array items: type: string format: uuid group_ids: type: array items: type: string format: uuid created_at: type: string format: date-time description: An ISO8601 date-time representing the entity's creation date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time representing the entity's most recent updated date-time. readOnly: true deleted_at: type: - string - 'null' format: date-time description: An ISO8601 date-time representing the entity's deletion date-time. readOnly: true relationships: type: object required: - creator - workspace 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 - 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 example: data: id: f649cebe-3dce-441a-8335-86707303c388 type: category attributes: title: Time For Coffee depth: 0 position: 0 block_size: medium view_mode: default group_by_strategy: null group_by_exclude_empty_groupings: true is_supportive: false created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' relationships: view: data: id: c3f80757-c0ea-422c-aa51-3c9ef8e11a76 type: view block_connectors: data: - id: 48517d52-3a25-4ca6-a7f5-55a3817fc00f type: block_connector blocks: data: - id: 24b4dd04-e56a-4794-95fa-ea0a0709b5a6 type: block category_type: data: null charts: data: [] creator: data: id: 61876808-5d57-455d-ba52-4ded14070b4b type: user filter_set: data: null group_by_custom_field: data: null parent_category: data: id: 10f0c22d-572c-4310-8849-9bcbe7f440ad type: category meta: effective_category_type_id: 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 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: - Categories operationId: UpdateCategoryV3 summary: Update an existing Category. security: - oauth2: - offline_access - api_key: [] parameters: - name: category_id in: path required: true description: The ID of the Category. 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: - block_template - block_connectors - block_connectors.block - blocks - category_type - filter_set - group_by_custom_field - view style: form explode: false 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: - category attributes: type: object additionalProperties: false properties: title: type: - string - 'null' description: A descriptive name for the 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: - 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. ' relationships: type: object 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 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 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 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 responses: '200': description: An updated category resource. content: application/json: schema: type: object required: - data properties: data: 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 included: type: array items: oneOf: - 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: 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: custom_field type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field attributes: type: object required: - description - display_name - is_deactivated - is_color_disabled - is_cascading - is_system_generated - metadata - created_at - updated_at additionalProperties: false properties: display_name: type: string description: 'The display name which will appear in the Opal application UI where used. ' description: type: - string - 'null' description: A plain text description of the custom field. is_deactivated: type: boolean description: 'A true/false value indicating whether this custom field is available for use within the Opal application. Note that this is separate from deleting the custom field. ' is_color_disabled: type: boolean description: 'Controls whether color relationships defined on options are displayed in the UI. When true, colors are hidden without removing the underlying color relationship settings. ' is_cascading: type: boolean description: 'PROPOSED: Indicates if blocks whose block_type has this custom_field enabled will inherit the values set for this custom field from its nearest ancestor block. Setting explicit values for this custom_field on a block will override inherited values. ' is_system_generated: type: boolean default: false readOnly: true description: 'Whether this field was auto-generated by the system rather than created by a user. Such fields currently cannot be renamed or deleted, though this may change in the future. Relevant for fields like the ‘Status’ single-select.' metadata: type: - object - 'null' deprecated: true description: 'You **SHOULD NOT** read this data. Instead, you **SHOULD** add `active_options` (and, if relevant, `deleted_options`) to the `custom_fields` request’s `include` query, and use the included `custom_field_option` resources. Explanation: serializing a few attributes from relationships in the `metadata` attribute was convenient for internal use while the `custom_field` resource was in development, but it’s not compliant with JSON:API, and the `include` approach is superior anyhow as allows callers full control over what data is included. `metadata/options` also has a different implementation than `custom_field_option` resources, so there’s some risk the two representations will become inconsistent.' oneOf: - title: Empty Object type: - object - 'null' additionalProperties: false description: 'The empty object for custom fields based on custom field types which have no configurable settings. ' - title: Single Select Metadata (V1) type: object required: - options properties: options: type: array items: type: object required: - id - display_name - position properties: id: type: string description: The ID of the option. Must be globally unique and a UUID. display_name: type: string description: The display value for this option. Must be unique across non-deleted siblings. position: type: integer description: The ordinal position of this option. Must be unique across non-deleted siblings. deleted_at: type: - string - 'null' format: date-time description: 'An ISO8601 date-time value, which will remove the given option from being usable. Once an option is created, it cannot be outright removed from the system. Instead, it can be deactivated by setting this value to a date-time value. One can set this to a value to remove the option from being usable, or null to restore it and make it usable again. Note that setting this to null will only be successful if doing so does not clobber the position or name of another non-deleted sibling. ' relationships: type: object additionalProperties: false properties: custom_field_color: allOf: - 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_color description: 'A relationship to a color for this option. Can be omitted (no color), included with null data (explicitly no color), or included with valid color data. ' paired_label: allOf: - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label description: 'A relationship to a label that’s been paired with this option. ' created_at: type: string format: date-time description: An ISO8601 date-time representing the entity's creation date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time representing the entity's most recent updated date-time. readOnly: true relationships: type: object required: - custom_field_type - workspace - active_options - deleted_options - creator additionalProperties: false properties: active_options: 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_option deleted_options: 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_option custom_field_type: 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: - custom_field_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 paired_label_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: - label_set 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 - title: filter_set type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - filter_set attributes: type: object required: - resource_type - filter - created_at - updated_at - deleted_at additionalProperties: false properties: resource_type: type: string enum: - block filter: type: object additionalProperties: false properties: plan_ids: type: array items: type: string format: uuid grandparent_plan_ids: type: array items: type: string format: uuid custom_fields: type: object additionalProperties: oneOf: - type: array items: type: string format: uuid - type: object additionalProperties: false required: - user_ids - group_ids properties: user_ids: type: array items: type: string format: uuid group_ids: type: array items: type: string format: uuid created_at: type: string format: date-time description: An ISO8601 date-time representing the entity's creation date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time representing the entity's most recent updated date-time. readOnly: true deleted_at: type: - string - 'null' format: date-time description: An ISO8601 date-time representing the entity's deletion date-time. readOnly: true relationships: type: object required: - creator - workspace 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 - 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 example: data: id: f649cebe-3dce-441a-8335-86707303c388 type: category attributes: title: Time For Coffee depth: 0 position: 0 block_size: medium view_mode: default group_by_strategy: null group_by_exclude_empty_groupings: true is_supportive: false created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' relationships: view: data: id: c3f80757-c0ea-422c-aa51-3c9ef8e11a76 type: view block_connectors: data: - id: 48517d52-3a25-4ca6-a7f5-55a3817fc00f type: block_connector blocks: data: - id: 24b4dd04-e56a-4794-95fa-ea0a0709b5a6 type: block category_type: data: null charts: data: [] creator: data: id: 61876808-5d57-455d-ba52-4ded14070b4b type: user filter_set: data: null group_by_custom_field: data: null parent_category: data: id: 10f0c22d-572c-4310-8849-9bcbe7f440ad type: category meta: effective_category_type_id: b69138d6-be91-44f7-b6ef-6e9c5abed51d '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 delete: tags: - Categories operationId: DeleteCategoryV3 summary: Delete a Category by the given ID security: - oauth2: - offline_access - api_key: [] parameters: - name: category_id in: path required: true description: The ID of the Category. schema: type: string format: uuid responses: '204': description: The requested Category has been 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 components: securitySchemes: 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. 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 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-tagGroups: - name: Stable tags: - Board Collaborators - Board Objects - Boards - Content Schedules - Moment Schedules - Moments - Onboarding - name: ⚠️ Unstable tags: - Block Connectors - Board Columns - Board Duplication - Board Standard Columns - Channels - Custom Field Options - Custom Field Types - Custom Fields - Moment Assignees - Moment Custom Fields - Planning Status - Rich Text Documents - User Groups - Users - Workspaces - name: ℹ️ Proposed tags: - Bulk Operations - Gem Chats - Gem Files - Moment Duplication - Presentation Themes - Workflows - Workflow Contexts - Workflow Stages - Workflow Assignments - Workflow Responses - name: ⚛️ Experimental tags: - Blocks - Block Custom Field Values - Block Duplication - Board User Settings - Categories - Category Types - Charts - Content - Custom Field Colors - Filter Sets - Key Dates - View Columns - View Standard Columns - Views - View Colors - Stories - name: Additional Resources tags: - secondary_resources