openapi: 3.2.0 info: version: 3.0.0 title: Opal API (⚠️ WIP) Boards 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: Boards paths: /boards/v3: get: tags: - Boards operationId: ReadBoardsV3 summary: Get Boards available to the authenticated user. security: - oauth2: - offline_access - api_key: [] parameters: - name: filter in: query description: 'Filters for limiting the results. ' required: false schema: type: object properties: workspace_id: type: array description: 'The IDs of the workspaces to which results should be filtered. Comma separated list of IDs. If included, will only fetch resources associated with these workspaces. If not included, will return resources associated with all workspaces that the user belongs to. For example, `filter[workspace_id]=798ac6d9-b3fc-4155-88ee-237f43f3404b` will fetch all resources associated with workspace `798ac6d9-b3fc-4155-88ee-237f43f3404b`, while `filter[workspace_id]=798ac6d9-b3fc-4155-88ee-237f43f3404b,d79e513e-9246-454e-80bf-8268bc39cd6e,f2b19a4a-ba0c-49be-8aa7-a1bf68a4a4ed` will fetch any resources associated with workspaces `798ac6d9-b3fc-4155-88ee-237f43f3404b`, `d79e513e-9246-454e-80bf-8268bc39cd6e`, or `f2b19a4a-ba0c-49be-8aa7-a1bf68a4a4ed`. ' items: type: string format: uuid id: type: array description: 'The IDs of the resources that should be returned. Comma separated list of IDs. If included, will only attempt to fetch resources matching those IDs. (Note that some or all resources may not be available.) If not included, will return all resources matching the other provided filters. For example, `filter[id]=798ac6d9-b3fc-4155-88ee-237f43f3404b` will fetch the resource with id `798ac6d9-b3fc-4155-88ee-237f43f3404b`, while `filter[id]=798ac6d9-b3fc-4155-88ee-237f43f3404b,d79e513e-9246-454e-80bf-8268bc39cd6e,f2b19a4a-ba0c-49be-8aa7-a1bf68a4a4ed` will fetch each of the resources with the ids `798ac6d9-b3fc-4155-88ee-237f43f3404b`, `d79e513e-9246-454e-80bf-8268bc39cd6e`, or `f2b19a4a-ba0c-49be-8aa7-a1bf68a4a4ed`. ' items: type: string format: uuid is_archived: description: By default archived boards are omitted. Set this filter to `true` to retrieve archived boards. type: boolean is_starred: description: Setting to `true` will only returns boards that the current user has ‘starred’. type: boolean style: deepObject explode: true - name: include in: query required: false description: A comma separated value of related objects to include. schema: type: array items: type: string enum: - asset_reference - board_collaborators - board_objects - board_columns - board_user_setting - collaborators - collaborators.profile - collaborators.profile.avatar_asset_reference - object_collections - created_by_user - created_by_user.profile - created_by_user.profile.avatar_asset_reference - default_story style: form explode: false - name: fields in: query description: 'A JSON:API [sparse fieldset](https://jsonapi.org/format/#fetching-sparse-fieldsets) declaration. The resource type can be that of the primary resource (i.e. `board`) or any of the included resources (e.g. `title` or `workspace`). ' required: false schema: type: object properties: asset_reference: type: string board: type: string board_columns: type: string board_collaborators: type: string board_objects: type: string board_user_setting: type: string collaborators: type: string created_by_user: type: string object_collections: type: string workspace: type: string style: deepObject explode: true - name: sort in: query description: 'A comma separated value specifying how a collection in the response body should be sorted, where each value is an attribute of the board. When specifying multiple values, each value in the sequence determines the ordering precedence. Each board in the collection will appear in ascending order, unless any of the enumerated values are prefixed with a minus "-" sign, in which case each board will appear in descending order for the specified values. ' required: false schema: type: string enum: - created_at - -created_at - updated_at - -updated_at - title - -title - name: page description: Specify an offset and limit for pagination in: query required: false schema: type: object properties: limit: type: integer default: 50 offset: type: integer style: deepObject explode: true responses: '200': description: A collection of Boards. content: application/json: schema: type: object required: - data - meta properties: data: type: array items: title: board type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board attributes: type: object required: - created_at - description - is_public - is_archived - title - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the board. is_public: type: boolean description: 'Indicates whether or not a board and all of its contents are visible to users in the workspace. Unless otherwise specified, this value is `false` by default. Boards are always visible to the user that created them. ' is_archived: type: boolean description: 'Indicates whether or not a board has been archived. If set to `true`, the UI will only display the board in the ‘Archived Boards’ view. If set to `false` (the default), the board may be displayed in other views, depending on the user’s filter settings. ' title: type: string description: The name of the board. updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object additionalProperties: false required: - created_by_user - workspace properties: asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference board_collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_collaborator board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user object_collections: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace board_columns: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_column board_user_setting: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_user_setting default_story: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - story included: type: array items: oneOf: - title: asset_reference type: object required: - id - type - attributes additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset_reference attributes: type: object required: - asset_type - content_type - created_at - description - escaped_filename - filename - filesize - format - full_url - height - legacy_id - meta_data - original_url - preview_url - public_id - updated_at - width additionalProperties: false properties: asset_type: type: - string - 'null' content_type: type: - string - 'null' created_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time readOnly: true description: type: - string - 'null' escaped_filename: type: string filename: type: - string - 'null' filesize: type: - integer - 'null' description: Size of file in bytes. format: type: - string - 'null' full_url: type: - string - 'null' height: type: - integer - 'null' legacy_id: type: string description: A legacy ID that can be used with `v2` API endpoints. meta_data: type: - object - 'null' original_url: type: - string - 'null' preview_url: type: - string - 'null' public_id: type: - string - 'null' x-not-relationship: true updated_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time readOnly: true width: type: - integer - 'null' relationships: type: object additionalProperties: false 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 cover_asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference - title: board_collaborator type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_collaborator attributes: type: object required: - created_at - updated_at additionalProperties: false properties: 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: - board - collaborator - collaborator_group additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board collaborator: title: User 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: - user collaborator_group: title: User Group 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: - user_group - title: board_object type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object attributes: type: object required: - position - created_at - updated_at additionalProperties: false properties: position: type: integer description: "An integer indicating the zero-based ordinal position of this \nboard object relative to other board objects.\n" 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: - board additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board board_object_collection: 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: - board_object_collection moment: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment rich_text_document: 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: - rich_text_document - title: board_column type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_column attributes: type: object required: - position - is_enabled additionalProperties: false properties: position: type: integer description: "An integer indicating the zero-based ordinal position of this \nboard column relative to other board columns.\n" is_enabled: type: boolean description: 'A value indicating whether this column is to be displayed in the UI when viewing the given board. ' 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: - board additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board board_standard_column: 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: - board_standard_column 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 custom_field_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: - custom_field_type - title: board_object_collection type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection attributes: type: object required: - created_at - description - position - title - hide_empty_table - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the object collection. position: type: integer description: 'An integer indicating the ordering of the Board Object Collection, relative to other collections within the same board. ' title: type: string description: The name of the board. hide_empty_table: type: boolean description: 'A boolean indicating if the moments table in a board object collection should be hidden when it has no moments. ' updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - board - created_by_user additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object - title: user type: object required: - id - type - attributes - relationships - links additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user meta: type: - object - 'null' description: Metadata around the User object properties: workspace_approval_counts: type: object description: Object representing the user's unseen approval counts per Workspace Id. attributes: type: object required: - created_at - email - first_name - full_name - is_active - last_name - title - transliterated_full_name - updated_at - legacy_id additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true email: type: string first_name: type: string full_name: type: string is_active: type: - boolean - 'null' last_name: type: string role_name: type: string title: type: - string - 'null' transliterated_full_name: type: string feature_flags: type: object additionalProperties: type: boolean description: 'A named feature flag and `true` or `false` depending on whether the feature is enabled for the user or not. ' description: 'List of Feature Flags for this user, only available for the currently authenticated User. ' updated_at: type: string format: date-time description: An ISO8601 date-time indicating when the user was last updated. readOnly: true legacy_id: type: string description: An ID that can be used with `v2` APIs. relationships: type: object required: - profile - workspaces additionalProperties: false properties: profile: 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: - user_profile workspaces: 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: - workspace links: type: object additionalProperties: false required: - v2_request properties: v2_request: type: string format: uri - title: user_profile type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user_profile attributes: type: object required: - bio - created_at - job_title - location - segments - updated_at - legacy_id additionalProperties: false properties: bio: type: - string - 'null' created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true job_title: type: - string - 'null' location: type: - string - 'null' segments: type: - array - 'null' items: type: string description: List of user-selected job functions to more accurately describe their role and responsibilities. updated_at: type: string format: date-time description: An ISO8601 date-time indicating when the user was last updated. readOnly: true legacy_id: type: string description: An ID that can be used with `v2` APIs. relationships: type: object required: - avatar_asset_reference - user additionalProperties: false properties: avatar_asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user - title: board_user_setting type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_user_setting attributes: type: object required: - is_starred - is_subscribed additionalProperties: false properties: 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 is_starred: type: boolean description: 'Indicates whether the current user has ''starred'' the board for more convenient access. ' is_subscribed: type: boolean description: 'Indicates whether the current user has subscribed to receive notifications for this board. ' relationships: type: object additionalProperties: false required: - board - user properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board user: 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 - title: story type: object required: - id - type - attributes additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - story meta: type: - object - 'null' description: 'Calculated story metadata included unconditionally in responses. ' 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: - color - created_at - description - is_shared - legacy_id - name - scheduled_end_at - scheduled_start_at - updated_at additionalProperties: false properties: color: type: - string - 'null' description: A hex color value with the '#' prefix. created_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time readOnly: true description: type: - string - 'null' is_shared: type: - boolean - 'null' legacy_id: type: string description: A legacy ID that can be used with `v2` API endpoints. name: type: string scheduled_start_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time scheduled_end_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time updated_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time readOnly: true relationships: type: object additionalProperties: false properties: workspace: 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: - workspace shared_workspaces: description: Additional workspaces that the story has been shared to. 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: - workspace links: type: object additionalProperties: false properties: v2_request: type: string description: A link to the equivalent v2 API request for this story. meta: type: object required: - total - page - resource_type properties: resource_type: type: string total: type: integer page: type: object required: - limit - offset properties: limit: type: integer offset: type: integer example: data: - id: d19806fe-55b3-4682-9d67-07343fea3975 type: board attributes: title: Ideation Board description: A place to brainstorm. is_public: false is_archived: false created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' relationships: asset_reference: data: id: c3f80757-c0ea-422c-aa51-3c9ef8e11a76 type: asset_reference board_collaborators: data: - id: 24b4dd04-e56a-4794-95fa-ea0a0709b5a6 type: board_collaborator board_objects: data: - id: 145f0f07-7c59-4b9a-939f-54c4979a5ab5 type: board_object collaborators: data: - id: a6b8c89d-718b-4988-9da5-fe95815efa60 type: user created_by_user: data: id: e0b0028d-e4ee-438d-800f-31f8d4048293 type: user object_collections: data: - id: eeb4599e-c212-471f-8c58-7b8b894b39af type: board_object_collection workspace: data: id: 801ba99f-f5d1-441c-8cc7-fc61acc6a8f7 type: workspace board_columns: data: - id: cc88909c-ff4c-417f-8732-d337f0fe761d type: board_column default_story: data: id: 71b7f79b-7ec4-4603-834e-41880630401d type: story '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 '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 post: tags: - Boards operationId: CreateBoardV3 summary: Create a new Board. security: - oauth2: - offline_access - api_key: [] requestBody: content: application/json: schema: type: object required: - data properties: data: type: object required: - type - attributes - relationships properties: type: type: string enum: - board attributes: type: object required: - title properties: title: type: string description: The title of the board. description: type: - string - 'null' description: A longer text field describing the board. is_public: type: boolean default: false description: 'Indicates whether or not a board is visible to users in the workspace. Setting this to `true` will allow all users in the workspace to see the board. Setting it to `false` will only allow the user that originally created the board to see it. ' relationships: type: object required: - workspace properties: asset_reference: description: The cover image of the board. type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference default_story: description: The default Story assignment for all new Moments created on this board. type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - story 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 responses: '201': description: A newly created board resource. content: application/json: schema: type: object required: - data properties: data: title: board type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board attributes: type: object required: - created_at - description - is_public - is_archived - title - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the board. is_public: type: boolean description: 'Indicates whether or not a board and all of its contents are visible to users in the workspace. Unless otherwise specified, this value is `false` by default. Boards are always visible to the user that created them. ' is_archived: type: boolean description: 'Indicates whether or not a board has been archived. If set to `true`, the UI will only display the board in the ‘Archived Boards’ view. If set to `false` (the default), the board may be displayed in other views, depending on the user’s filter settings. ' title: type: string description: The name of the board. updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object additionalProperties: false required: - created_by_user - workspace properties: asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference board_collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_collaborator board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user object_collections: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace board_columns: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_column board_user_setting: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_user_setting default_story: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - story included: type: array items: oneOf: - title: asset_reference type: object required: - id - type - attributes additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset_reference attributes: type: object required: - asset_type - content_type - created_at - description - escaped_filename - filename - filesize - format - full_url - height - legacy_id - meta_data - original_url - preview_url - public_id - updated_at - width additionalProperties: false properties: asset_type: type: - string - 'null' content_type: type: - string - 'null' created_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time readOnly: true description: type: - string - 'null' escaped_filename: type: string filename: type: - string - 'null' filesize: type: - integer - 'null' description: Size of file in bytes. format: type: - string - 'null' full_url: type: - string - 'null' height: type: - integer - 'null' legacy_id: type: string description: A legacy ID that can be used with `v2` API endpoints. meta_data: type: - object - 'null' original_url: type: - string - 'null' preview_url: type: - string - 'null' public_id: type: - string - 'null' x-not-relationship: true updated_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time readOnly: true width: type: - integer - 'null' relationships: type: object additionalProperties: false 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 cover_asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference - title: board_collaborator type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_collaborator attributes: type: object required: - created_at - updated_at additionalProperties: false properties: 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: - board - collaborator - collaborator_group additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board collaborator: title: User 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: - user collaborator_group: title: User Group 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: - user_group - title: board_object type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object attributes: type: object required: - position - created_at - updated_at additionalProperties: false properties: position: type: integer description: "An integer indicating the zero-based ordinal position of this \nboard object relative to other board objects.\n" 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: - board additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board board_object_collection: 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: - board_object_collection moment: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment rich_text_document: 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: - rich_text_document - title: board_column type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_column attributes: type: object required: - position - is_enabled additionalProperties: false properties: position: type: integer description: "An integer indicating the zero-based ordinal position of this \nboard column relative to other board columns.\n" is_enabled: type: boolean description: 'A value indicating whether this column is to be displayed in the UI when viewing the given board. ' 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: - board additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board board_standard_column: 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: - board_standard_column 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 custom_field_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: - custom_field_type - title: board_object_collection type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection attributes: type: object required: - created_at - description - position - title - hide_empty_table - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the object collection. position: type: integer description: 'An integer indicating the ordering of the Board Object Collection, relative to other collections within the same board. ' title: type: string description: The name of the board. hide_empty_table: type: boolean description: 'A boolean indicating if the moments table in a board object collection should be hidden when it has no moments. ' updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - board - created_by_user additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object - title: user type: object required: - id - type - attributes - relationships - links additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user meta: type: - object - 'null' description: Metadata around the User object properties: workspace_approval_counts: type: object description: Object representing the user's unseen approval counts per Workspace Id. attributes: type: object required: - created_at - email - first_name - full_name - is_active - last_name - title - transliterated_full_name - updated_at - legacy_id additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true email: type: string first_name: type: string full_name: type: string is_active: type: - boolean - 'null' last_name: type: string role_name: type: string title: type: - string - 'null' transliterated_full_name: type: string feature_flags: type: object additionalProperties: type: boolean description: 'A named feature flag and `true` or `false` depending on whether the feature is enabled for the user or not. ' description: 'List of Feature Flags for this user, only available for the currently authenticated User. ' updated_at: type: string format: date-time description: An ISO8601 date-time indicating when the user was last updated. readOnly: true legacy_id: type: string description: An ID that can be used with `v2` APIs. relationships: type: object required: - profile - workspaces additionalProperties: false properties: profile: 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: - user_profile workspaces: 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: - workspace links: type: object additionalProperties: false required: - v2_request properties: v2_request: type: string format: uri - title: user_profile type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user_profile attributes: type: object required: - bio - created_at - job_title - location - segments - updated_at - legacy_id additionalProperties: false properties: bio: type: - string - 'null' created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true job_title: type: - string - 'null' location: type: - string - 'null' segments: type: - array - 'null' items: type: string description: List of user-selected job functions to more accurately describe their role and responsibilities. updated_at: type: string format: date-time description: An ISO8601 date-time indicating when the user was last updated. readOnly: true legacy_id: type: string description: An ID that can be used with `v2` APIs. relationships: type: object required: - avatar_asset_reference - user additionalProperties: false properties: avatar_asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user - title: board_user_setting type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_user_setting attributes: type: object required: - is_starred - is_subscribed additionalProperties: false properties: 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 is_starred: type: boolean description: 'Indicates whether the current user has ''starred'' the board for more convenient access. ' is_subscribed: type: boolean description: 'Indicates whether the current user has subscribed to receive notifications for this board. ' relationships: type: object additionalProperties: false required: - board - user properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board user: 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 - title: story type: object required: - id - type - attributes additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - story meta: type: - object - 'null' description: 'Calculated story metadata included unconditionally in responses. ' 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: - color - created_at - description - is_shared - legacy_id - name - scheduled_end_at - scheduled_start_at - updated_at additionalProperties: false properties: color: type: - string - 'null' description: A hex color value with the '#' prefix. created_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time readOnly: true description: type: - string - 'null' is_shared: type: - boolean - 'null' legacy_id: type: string description: A legacy ID that can be used with `v2` API endpoints. name: type: string scheduled_start_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time scheduled_end_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time updated_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time readOnly: true relationships: type: object additionalProperties: false properties: workspace: 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: - workspace shared_workspaces: description: Additional workspaces that the story has been shared to. 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: - workspace links: type: object additionalProperties: false properties: v2_request: type: string description: A link to the equivalent v2 API request for this story. example: data: id: d19806fe-55b3-4682-9d67-07343fea3975 type: board attributes: title: Ideation Board description: A place to brainstorm. is_public: false is_archived: false created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' relationships: asset_reference: data: id: c3f80757-c0ea-422c-aa51-3c9ef8e11a76 type: asset_reference board_collaborators: data: - id: 24b4dd04-e56a-4794-95fa-ea0a0709b5a6 type: board_collaborator board_objects: data: - id: 145f0f07-7c59-4b9a-939f-54c4979a5ab5 type: board_object collaborators: data: - id: a6b8c89d-718b-4988-9da5-fe95815efa60 type: user created_by_user: data: id: e0b0028d-e4ee-438d-800f-31f8d4048293 type: user object_collections: data: - id: eeb4599e-c212-471f-8c58-7b8b894b39af type: board_object_collection workspace: data: id: 801ba99f-f5d1-441c-8cc7-fc61acc6a8f7 type: workspace board_columns: data: - id: cc88909c-ff4c-417f-8732-d337f0fe761d type: board_column default_story: data: id: 71b7f79b-7ec4-4603-834e-41880630401d type: story '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 '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 /boards/v3/{board_id}: get: tags: - Boards operationId: ReadBoardV3 summary: Get a Board. security: - oauth2: - offline_access - api_key: [] parameters: - name: board_id in: path required: true description: The ID of the Board. schema: type: string format: uuid - name: include in: query required: false description: A comma separated value of related objects to include. schema: type: array items: type: string enum: - asset_reference - board_collaborators - board_objects - board_columns - board_user_setting - collaborators - collaborators.profile - collaborators.profile.avatar_asset_reference - object_collections - created_by_user - created_by_user.profile - created_by_user.profile.avatar_asset_reference - default_story style: form explode: false responses: '200': description: The requested Board content: application/json: schema: type: object required: - data properties: data: title: board type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board attributes: type: object required: - created_at - description - is_public - is_archived - title - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the board. is_public: type: boolean description: 'Indicates whether or not a board and all of its contents are visible to users in the workspace. Unless otherwise specified, this value is `false` by default. Boards are always visible to the user that created them. ' is_archived: type: boolean description: 'Indicates whether or not a board has been archived. If set to `true`, the UI will only display the board in the ‘Archived Boards’ view. If set to `false` (the default), the board may be displayed in other views, depending on the user’s filter settings. ' title: type: string description: The name of the board. updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object additionalProperties: false required: - created_by_user - workspace properties: asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference board_collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_collaborator board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user object_collections: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace board_columns: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_column board_user_setting: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_user_setting default_story: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - story included: type: array items: oneOf: - title: asset_reference type: object required: - id - type - attributes additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset_reference attributes: type: object required: - asset_type - content_type - created_at - description - escaped_filename - filename - filesize - format - full_url - height - legacy_id - meta_data - original_url - preview_url - public_id - updated_at - width additionalProperties: false properties: asset_type: type: - string - 'null' content_type: type: - string - 'null' created_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time readOnly: true description: type: - string - 'null' escaped_filename: type: string filename: type: - string - 'null' filesize: type: - integer - 'null' description: Size of file in bytes. format: type: - string - 'null' full_url: type: - string - 'null' height: type: - integer - 'null' legacy_id: type: string description: A legacy ID that can be used with `v2` API endpoints. meta_data: type: - object - 'null' original_url: type: - string - 'null' preview_url: type: - string - 'null' public_id: type: - string - 'null' x-not-relationship: true updated_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time readOnly: true width: type: - integer - 'null' relationships: type: object additionalProperties: false 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 cover_asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference - title: board_collaborator type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_collaborator attributes: type: object required: - created_at - updated_at additionalProperties: false properties: 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: - board - collaborator - collaborator_group additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board collaborator: title: User 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: - user collaborator_group: title: User Group 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: - user_group - title: board_object type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object attributes: type: object required: - position - created_at - updated_at additionalProperties: false properties: position: type: integer description: "An integer indicating the zero-based ordinal position of this \nboard object relative to other board objects.\n" 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: - board additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board board_object_collection: 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: - board_object_collection moment: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment rich_text_document: 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: - rich_text_document - title: board_column type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_column attributes: type: object required: - position - is_enabled additionalProperties: false properties: position: type: integer description: "An integer indicating the zero-based ordinal position of this \nboard column relative to other board columns.\n" is_enabled: type: boolean description: 'A value indicating whether this column is to be displayed in the UI when viewing the given board. ' 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: - board additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board board_standard_column: 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: - board_standard_column 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 custom_field_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: - custom_field_type - title: board_object_collection type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection attributes: type: object required: - created_at - description - position - title - hide_empty_table - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the object collection. position: type: integer description: 'An integer indicating the ordering of the Board Object Collection, relative to other collections within the same board. ' title: type: string description: The name of the board. hide_empty_table: type: boolean description: 'A boolean indicating if the moments table in a board object collection should be hidden when it has no moments. ' updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - board - created_by_user additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object - title: user type: object required: - id - type - attributes - relationships - links additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user meta: type: - object - 'null' description: Metadata around the User object properties: workspace_approval_counts: type: object description: Object representing the user's unseen approval counts per Workspace Id. attributes: type: object required: - created_at - email - first_name - full_name - is_active - last_name - title - transliterated_full_name - updated_at - legacy_id additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true email: type: string first_name: type: string full_name: type: string is_active: type: - boolean - 'null' last_name: type: string role_name: type: string title: type: - string - 'null' transliterated_full_name: type: string feature_flags: type: object additionalProperties: type: boolean description: 'A named feature flag and `true` or `false` depending on whether the feature is enabled for the user or not. ' description: 'List of Feature Flags for this user, only available for the currently authenticated User. ' updated_at: type: string format: date-time description: An ISO8601 date-time indicating when the user was last updated. readOnly: true legacy_id: type: string description: An ID that can be used with `v2` APIs. relationships: type: object required: - profile - workspaces additionalProperties: false properties: profile: 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: - user_profile workspaces: 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: - workspace links: type: object additionalProperties: false required: - v2_request properties: v2_request: type: string format: uri - title: user_profile type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user_profile attributes: type: object required: - bio - created_at - job_title - location - segments - updated_at - legacy_id additionalProperties: false properties: bio: type: - string - 'null' created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true job_title: type: - string - 'null' location: type: - string - 'null' segments: type: - array - 'null' items: type: string description: List of user-selected job functions to more accurately describe their role and responsibilities. updated_at: type: string format: date-time description: An ISO8601 date-time indicating when the user was last updated. readOnly: true legacy_id: type: string description: An ID that can be used with `v2` APIs. relationships: type: object required: - avatar_asset_reference - user additionalProperties: false properties: avatar_asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user - title: board_user_setting type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_user_setting attributes: type: object required: - is_starred - is_subscribed additionalProperties: false properties: 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 is_starred: type: boolean description: 'Indicates whether the current user has ''starred'' the board for more convenient access. ' is_subscribed: type: boolean description: 'Indicates whether the current user has subscribed to receive notifications for this board. ' relationships: type: object additionalProperties: false required: - board - user properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board user: 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 - title: story type: object required: - id - type - attributes additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - story meta: type: - object - 'null' description: 'Calculated story metadata included unconditionally in responses. ' 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: - color - created_at - description - is_shared - legacy_id - name - scheduled_end_at - scheduled_start_at - updated_at additionalProperties: false properties: color: type: - string - 'null' description: A hex color value with the '#' prefix. created_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time readOnly: true description: type: - string - 'null' is_shared: type: - boolean - 'null' legacy_id: type: string description: A legacy ID that can be used with `v2` API endpoints. name: type: string scheduled_start_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time scheduled_end_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time updated_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time readOnly: true relationships: type: object additionalProperties: false properties: workspace: 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: - workspace shared_workspaces: description: Additional workspaces that the story has been shared to. 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: - workspace links: type: object additionalProperties: false properties: v2_request: type: string description: A link to the equivalent v2 API request for this story. example: data: id: d19806fe-55b3-4682-9d67-07343fea3975 type: board attributes: title: Ideation Board description: A place to brainstorm. is_public: false is_archived: false created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' relationships: asset_reference: data: id: c3f80757-c0ea-422c-aa51-3c9ef8e11a76 type: asset_reference board_collaborators: data: - id: 24b4dd04-e56a-4794-95fa-ea0a0709b5a6 type: board_collaborator board_objects: data: - id: 145f0f07-7c59-4b9a-939f-54c4979a5ab5 type: board_object collaborators: data: - id: a6b8c89d-718b-4988-9da5-fe95815efa60 type: user created_by_user: data: id: e0b0028d-e4ee-438d-800f-31f8d4048293 type: user object_collections: data: - id: eeb4599e-c212-471f-8c58-7b8b894b39af type: board_object_collection workspace: data: id: 801ba99f-f5d1-441c-8cc7-fc61acc6a8f7 type: workspace board_columns: data: - id: cc88909c-ff4c-417f-8732-d337f0fe761d type: board_column default_story: data: id: 71b7f79b-7ec4-4603-834e-41880630401d type: story '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: - Boards operationId: UpdateBoardV3 summary: Update an existing Board. security: - oauth2: - offline_access - api_key: [] parameters: - name: board_id in: path required: true description: The ID of the Board. schema: type: string format: uuid - name: include in: query required: false description: A comma separated value of related objects to include. schema: type: array items: type: string enum: - asset_reference - board_collaborators - board_objects - board_columns - board_user_setting - collaborators - collaborators.profile - collaborators.profile.avatar_asset_reference - object_collections - created_by_user - created_by_user.profile - created_by_user.profile.avatar_asset_reference - default_story 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: - board attributes: type: object properties: title: type: string description: The title of the board. description: type: - string - 'null' description: A longer text field describing the board. is_public: type: boolean description: 'Indicates whether or not a board is visible to users in the workspace. Setting this to `true` will allow all users in the workspace to see the board. Setting it to `false` will only allow the user that originally created the board to see it. ' is_archived: type: boolean description: 'Indicates whether or not a board has been archived. If set to `true`, the UI will only display the board in the ‘Archived Boards’ view. If set to `false` (the default), the board may be displayed in other views, depending on the user’s filter settings. ' relationships: type: object properties: asset_reference: description: The cover image of the board. type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference default_story: description: The default Story assignment for all new Moments created on this board. type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - story responses: '200': description: An updated board resource. content: application/json: schema: type: object required: - data properties: data: title: board type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board attributes: type: object required: - created_at - description - is_public - is_archived - title - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the board. is_public: type: boolean description: 'Indicates whether or not a board and all of its contents are visible to users in the workspace. Unless otherwise specified, this value is `false` by default. Boards are always visible to the user that created them. ' is_archived: type: boolean description: 'Indicates whether or not a board has been archived. If set to `true`, the UI will only display the board in the ‘Archived Boards’ view. If set to `false` (the default), the board may be displayed in other views, depending on the user’s filter settings. ' title: type: string description: The name of the board. updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object additionalProperties: false required: - created_by_user - workspace properties: asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference board_collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_collaborator board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user object_collections: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace board_columns: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_column board_user_setting: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_user_setting default_story: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - story included: type: array items: oneOf: - title: asset_reference type: object required: - id - type - attributes additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - asset_reference attributes: type: object required: - asset_type - content_type - created_at - description - escaped_filename - filename - filesize - format - full_url - height - legacy_id - meta_data - original_url - preview_url - public_id - updated_at - width additionalProperties: false properties: asset_type: type: - string - 'null' content_type: type: - string - 'null' created_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time readOnly: true description: type: - string - 'null' escaped_filename: type: string filename: type: - string - 'null' filesize: type: - integer - 'null' description: Size of file in bytes. format: type: - string - 'null' full_url: type: - string - 'null' height: type: - integer - 'null' legacy_id: type: string description: A legacy ID that can be used with `v2` API endpoints. meta_data: type: - object - 'null' original_url: type: - string - 'null' preview_url: type: - string - 'null' public_id: type: - string - 'null' x-not-relationship: true updated_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time readOnly: true width: type: - integer - 'null' relationships: type: object additionalProperties: false 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 cover_asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference - title: board_collaborator type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_collaborator attributes: type: object required: - created_at - updated_at additionalProperties: false properties: 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: - board - collaborator - collaborator_group additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board collaborator: title: User 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: - user collaborator_group: title: User Group 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: - user_group - title: board_object type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object attributes: type: object required: - position - created_at - updated_at additionalProperties: false properties: position: type: integer description: "An integer indicating the zero-based ordinal position of this \nboard object relative to other board objects.\n" 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: - board additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board board_object_collection: 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: - board_object_collection moment: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment rich_text_document: 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: - rich_text_document - title: board_column type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_column attributes: type: object required: - position - is_enabled additionalProperties: false properties: position: type: integer description: "An integer indicating the zero-based ordinal position of this \nboard column relative to other board columns.\n" is_enabled: type: boolean description: 'A value indicating whether this column is to be displayed in the UI when viewing the given board. ' 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: - board additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board board_standard_column: 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: - board_standard_column 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 custom_field_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: - custom_field_type - title: board_object_collection type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection attributes: type: object required: - created_at - description - position - title - hide_empty_table - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the object collection. position: type: integer description: 'An integer indicating the ordering of the Board Object Collection, relative to other collections within the same board. ' title: type: string description: The name of the board. hide_empty_table: type: boolean description: 'A boolean indicating if the moments table in a board object collection should be hidden when it has no moments. ' updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - board - created_by_user additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object - title: user type: object required: - id - type - attributes - relationships - links additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user meta: type: - object - 'null' description: Metadata around the User object properties: workspace_approval_counts: type: object description: Object representing the user's unseen approval counts per Workspace Id. attributes: type: object required: - created_at - email - first_name - full_name - is_active - last_name - title - transliterated_full_name - updated_at - legacy_id additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true email: type: string first_name: type: string full_name: type: string is_active: type: - boolean - 'null' last_name: type: string role_name: type: string title: type: - string - 'null' transliterated_full_name: type: string feature_flags: type: object additionalProperties: type: boolean description: 'A named feature flag and `true` or `false` depending on whether the feature is enabled for the user or not. ' description: 'List of Feature Flags for this user, only available for the currently authenticated User. ' updated_at: type: string format: date-time description: An ISO8601 date-time indicating when the user was last updated. readOnly: true legacy_id: type: string description: An ID that can be used with `v2` APIs. relationships: type: object required: - profile - workspaces additionalProperties: false properties: profile: 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: - user_profile workspaces: 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: - workspace links: type: object additionalProperties: false required: - v2_request properties: v2_request: type: string format: uri - title: user_profile type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user_profile attributes: type: object required: - bio - created_at - job_title - location - segments - updated_at - legacy_id additionalProperties: false properties: bio: type: - string - 'null' created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true job_title: type: - string - 'null' location: type: - string - 'null' segments: type: - array - 'null' items: type: string description: List of user-selected job functions to more accurately describe their role and responsibilities. updated_at: type: string format: date-time description: An ISO8601 date-time indicating when the user was last updated. readOnly: true legacy_id: type: string description: An ID that can be used with `v2` APIs. relationships: type: object required: - avatar_asset_reference - user additionalProperties: false properties: avatar_asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user - title: board_user_setting type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_user_setting attributes: type: object required: - is_starred - is_subscribed additionalProperties: false properties: 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 is_starred: type: boolean description: 'Indicates whether the current user has ''starred'' the board for more convenient access. ' is_subscribed: type: boolean description: 'Indicates whether the current user has subscribed to receive notifications for this board. ' relationships: type: object additionalProperties: false required: - board - user properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board user: 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 - title: story type: object required: - id - type - attributes additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - story meta: type: - object - 'null' description: 'Calculated story metadata included unconditionally in responses. ' 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: - color - created_at - description - is_shared - legacy_id - name - scheduled_end_at - scheduled_start_at - updated_at additionalProperties: false properties: color: type: - string - 'null' description: A hex color value with the '#' prefix. created_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time readOnly: true description: type: - string - 'null' is_shared: type: - boolean - 'null' legacy_id: type: string description: A legacy ID that can be used with `v2` API endpoints. name: type: string scheduled_start_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time scheduled_end_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time updated_at: type: string description: An ISO8601 date-time. Formatted as an 'Internet Date/Time' (RFC 3339). format: date-time readOnly: true relationships: type: object additionalProperties: false properties: workspace: 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: - workspace shared_workspaces: description: Additional workspaces that the story has been shared to. 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: - workspace links: type: object additionalProperties: false properties: v2_request: type: string description: A link to the equivalent v2 API request for this story. example: data: id: d19806fe-55b3-4682-9d67-07343fea3975 type: board attributes: title: Ideation Board description: A place to brainstorm. is_public: false is_archived: false created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' relationships: asset_reference: data: id: c3f80757-c0ea-422c-aa51-3c9ef8e11a76 type: asset_reference board_collaborators: data: - id: 24b4dd04-e56a-4794-95fa-ea0a0709b5a6 type: board_collaborator board_objects: data: - id: 145f0f07-7c59-4b9a-939f-54c4979a5ab5 type: board_object collaborators: data: - id: a6b8c89d-718b-4988-9da5-fe95815efa60 type: user created_by_user: data: id: e0b0028d-e4ee-438d-800f-31f8d4048293 type: user object_collections: data: - id: eeb4599e-c212-471f-8c58-7b8b894b39af type: board_object_collection workspace: data: id: 801ba99f-f5d1-441c-8cc7-fc61acc6a8f7 type: workspace board_columns: data: - id: cc88909c-ff4c-417f-8732-d337f0fe761d type: board_column default_story: data: id: 71b7f79b-7ec4-4603-834e-41880630401d type: story '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 '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: - Boards operationId: DeleteBoardV3 summary: Delete a Board. security: - oauth2: - offline_access - api_key: [] parameters: - name: board_id in: path required: true description: The ID of the Board. schema: type: string format: uuid responses: '204': description: The Board was successfully deleted. '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 '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 /boards/v3/{board_id}/user_setting: patch: tags: - Boards operationId: UpdateBoardUserSettingV3 summary: '[UNSTABLE] Update the user’s settings for a given Board' security: - oauth2: - offline_access - api_key: [] parameters: - name: board_id in: path required: true description: The ID of the Board. 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: - user 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 description: 'This MUST be a UUID, and MAY be the id taken from the resource’s GET request or the id provided in the board_user_setting relationship on another resource. If an API consumer doesn’t already have the appropriate UUID the consumer SHOULD use the nil UUID (`00000000-0000-0000-0000-000000000000`). This is only included for JSON:API compliance; a Board-User pair has exactly one setting record, so the server doesn’t need an id to find the correct record. ' type: type: string enum: - board_user_setting attributes: type: object properties: is_starred: type: boolean description: 'Indicates whether the current user has ''starred'' the board to find it more easily. If set to `true` the UI will have the same visibility as a non-starred board, but will also appear in the ''Starred'' view if visible to the current user. ' is_subscribed: type: boolean description: 'Indicates whether the current user has subscribed to receive notifications for this board. ' responses: '200': description: The updated user settings for the given board content: application/json: schema: type: object required: - data properties: data: title: board_user_setting type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_user_setting attributes: type: object required: - is_starred - is_subscribed additionalProperties: false properties: 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 is_starred: type: boolean description: 'Indicates whether the current user has ''starred'' the board for more convenient access. ' is_subscribed: type: boolean description: 'Indicates whether the current user has subscribed to receive notifications for this board. ' relationships: type: object additionalProperties: false required: - board - user properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board user: 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 included: type: array items: oneOf: - title: board type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board attributes: type: object required: - created_at - description - is_public - is_archived - title - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the board. is_public: type: boolean description: 'Indicates whether or not a board and all of its contents are visible to users in the workspace. Unless otherwise specified, this value is `false` by default. Boards are always visible to the user that created them. ' is_archived: type: boolean description: 'Indicates whether or not a board has been archived. If set to `true`, the UI will only display the board in the ‘Archived Boards’ view. If set to `false` (the default), the board may be displayed in other views, depending on the user’s filter settings. ' title: type: string description: The name of the board. updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object additionalProperties: false required: - created_by_user - workspace properties: asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference board_collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_collaborator board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object collaborators: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user object_collections: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace board_columns: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_column board_user_setting: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_user_setting default_story: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - story - title: user type: object required: - id - type - attributes - relationships - links additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user meta: type: - object - 'null' description: Metadata around the User object properties: workspace_approval_counts: type: object description: Object representing the user's unseen approval counts per Workspace Id. attributes: type: object required: - created_at - email - first_name - full_name - is_active - last_name - title - transliterated_full_name - updated_at - legacy_id additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true email: type: string first_name: type: string full_name: type: string is_active: type: - boolean - 'null' last_name: type: string role_name: type: string title: type: - string - 'null' transliterated_full_name: type: string feature_flags: type: object additionalProperties: type: boolean description: 'A named feature flag and `true` or `false` depending on whether the feature is enabled for the user or not. ' description: 'List of Feature Flags for this user, only available for the currently authenticated User. ' updated_at: type: string format: date-time description: An ISO8601 date-time indicating when the user was last updated. readOnly: true legacy_id: type: string description: An ID that can be used with `v2` APIs. relationships: type: object required: - profile - workspaces additionalProperties: false properties: profile: 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: - user_profile workspaces: 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: - workspace links: type: object additionalProperties: false required: - v2_request properties: v2_request: type: string format: uri example: data: id: b1127f87-7ecf-444e-8e0c-06eb752ff66b type: board_user_setting attributes: is_starred: true is_subscribed: false created_at: '2024-06-24T09:33:01.881-07:00' updated_at: '2024-06-24T09:33:01.881-07:00' relationships: board: data: id: d19806fe-55b3-4682-9d67-07343fea3975 type: board user: data: id: e0b0028d-e4ee-438d-800f-31f8d4048293 type: user '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 '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 /board_object_collections/v3: get: tags: - Boards operationId: GetBoardObjectCollectionsV3 summary: Get Object Collections available to the authenticated user. 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: - board_objects style: form explode: false - name: filter in: query description: 'Filters for limiting the results. ' required: false schema: type: object properties: board_id: description: Retrieve board object collections by the associated board ID. type: string format: uuid style: deepObject explode: true responses: '200': description: A collection of Object Collections. content: application/json: schema: type: object required: - data - meta properties: data: type: array items: title: board_object_collection type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection attributes: type: object required: - created_at - description - position - title - hide_empty_table - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the object collection. position: type: integer description: 'An integer indicating the ordering of the Board Object Collection, relative to other collections within the same board. ' title: type: string description: The name of the board. hide_empty_table: type: boolean description: 'A boolean indicating if the moments table in a board object collection should be hidden when it has no moments. ' updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - board - created_by_user additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object included: type: array items: oneOf: - title: board_object type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object attributes: type: object required: - position - created_at - updated_at additionalProperties: false properties: position: type: integer description: "An integer indicating the zero-based ordinal position of this \nboard object relative to other board objects.\n" 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: - board additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board board_object_collection: 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: - board_object_collection moment: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment rich_text_document: 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: - rich_text_document meta: type: object required: - total - page - resource_type properties: resource_type: type: string total: type: integer page: type: object required: - limit - offset properties: limit: type: integer offset: type: integer example: data: - id: 7f71cfc6-5ac2-43cb-b28b-21851007e039 type: board_object_collection attributes: created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' position: 0 title: Sub-board collection of ideas description: null hide_empty_table: false relationships: board: data: id: e5398d78-c404-4e78-9676-f425c3fe6260 type: board created_by_user: data: id: d1c1091a-1f64-411e-883e-016a0dbb0a27 type: user board_objects: data: - id: 04adc136-81b4-4830-8dfd-dbbce9369bcf type: board_object '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 '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 post: tags: - Boards operationId: CreateBoardObjectCollectionV3 summary: Create a new Board Object Collection. security: - oauth2: - offline_access - api_key: [] requestBody: content: application/json: schema: type: object required: - data properties: data: type: object required: - type - attributes - relationships properties: type: type: string enum: - board_object_collection attributes: type: object required: - position properties: title: type: string description: The title of the board object collection. position: type: number description: position index in the list of collections. description: type: - string - 'null' description: 'A longer text field describing the board object collection. ' hide_empty_table: type: boolean default: false description: 'A boolean indicating if the moments table in a board object collection should be hidden when it has no moments. ' relationships: type: object required: - board properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board responses: '201': description: A newly created Board Object Collection resource. content: application/json: schema: type: object required: - data properties: data: title: board_object_collection type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection attributes: type: object required: - created_at - description - position - title - hide_empty_table - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the object collection. position: type: integer description: 'An integer indicating the ordering of the Board Object Collection, relative to other collections within the same board. ' title: type: string description: The name of the board. hide_empty_table: type: boolean description: 'A boolean indicating if the moments table in a board object collection should be hidden when it has no moments. ' updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - board - created_by_user additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object included: type: array items: oneOf: - title: board_object type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object attributes: type: object required: - position - created_at - updated_at additionalProperties: false properties: position: type: integer description: "An integer indicating the zero-based ordinal position of this \nboard object relative to other board objects.\n" 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: - board additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board board_object_collection: 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: - board_object_collection moment: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment rich_text_document: 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: - rich_text_document example: data: id: 7f71cfc6-5ac2-43cb-b28b-21851007e039 type: board_object_collection attributes: created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' position: 0 title: Sub-board collection of ideas description: null hide_empty_table: false relationships: board: data: id: e5398d78-c404-4e78-9676-f425c3fe6260 type: board created_by_user: data: id: d1c1091a-1f64-411e-883e-016a0dbb0a27 type: user board_objects: data: - id: 04adc136-81b4-4830-8dfd-dbbce9369bcf type: board_object '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 '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 /board_object_collections/v3/{board_object_collection_id}: get: tags: - Boards operationId: ReadBoardObjectCollectionV3 summary: Get a Board Object Collection. security: - oauth2: - offline_access - api_key: [] parameters: - name: board_object_collection_id in: path required: true description: The ID of the Board Object Collection. 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: - board_objects style: form explode: false responses: '200': description: A single Board Object Collection. content: application/json: schema: type: object required: - data properties: data: title: board_object_collection type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection attributes: type: object required: - created_at - description - position - title - hide_empty_table - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the object collection. position: type: integer description: 'An integer indicating the ordering of the Board Object Collection, relative to other collections within the same board. ' title: type: string description: The name of the board. hide_empty_table: type: boolean description: 'A boolean indicating if the moments table in a board object collection should be hidden when it has no moments. ' updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - board - created_by_user additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object included: type: array items: oneOf: - title: board_object type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object attributes: type: object required: - position - created_at - updated_at additionalProperties: false properties: position: type: integer description: "An integer indicating the zero-based ordinal position of this \nboard object relative to other board objects.\n" 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: - board additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board board_object_collection: 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: - board_object_collection moment: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment rich_text_document: 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: - rich_text_document example: data: id: 7f71cfc6-5ac2-43cb-b28b-21851007e039 type: board_object_collection attributes: created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' position: 0 title: Sub-board collection of ideas description: null hide_empty_table: false relationships: board: data: id: e5398d78-c404-4e78-9676-f425c3fe6260 type: board created_by_user: data: id: d1c1091a-1f64-411e-883e-016a0dbb0a27 type: user board_objects: data: - id: 04adc136-81b4-4830-8dfd-dbbce9369bcf type: board_object '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 '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 patch: tags: - Boards operationId: UpdateBoardObjectCollectionV3 summary: Update a new Board Object Collection. security: - oauth2: - offline_access - api_key: [] parameters: - name: board_object_collection_id in: path required: true description: The ID of the Board Object Collection. 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: - board_objects style: form explode: false requestBody: content: application/json: schema: type: object required: - data properties: data: type: object required: - id - type - attributes - relationships properties: id: type: string format: uuid type: type: string enum: - board_object_collection attributes: type: object properties: title: type: string description: The title of the board object collection. description: type: - string - 'null' description: 'A longer text field describing the board object collection. ' hide_empty_table: type: boolean default: false description: 'A boolean indicating if the moments table in a board object collection should be hidden when it has no moments. ' position: type: integer description: 'An integer indicating the ordering of the board object collection relative to other collections within the same board. This attribute is zero-indexed, and increments by one. Note that in order to move a board object collection into a higher position than another, it is only necessary to change the position of the moving board object collection. All other board object collections will have their positions shifted automatically in response. ' relationships: type: object required: - board properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board moments: 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: - moment responses: '200': description: An updated Board Object Collection resource. content: application/json: schema: type: object required: - data properties: data: title: board_object_collection type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object_collection attributes: type: object required: - created_at - description - position - title - hide_empty_table - updated_at additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true description: type: - string - 'null' description: A description of the object collection. position: type: integer description: 'An integer indicating the ordering of the Board Object Collection, relative to other collections within the same board. ' title: type: string description: The name of the board. hide_empty_table: type: boolean description: 'A boolean indicating if the moments table in a board object collection should be hidden when it has no moments. ' updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - board - created_by_user additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board created_by_user: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user board_objects: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object included: type: array items: oneOf: - title: board_object type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board_object attributes: type: object required: - position - created_at - updated_at additionalProperties: false properties: position: type: integer description: "An integer indicating the zero-based ordinal position of this \nboard object relative to other board objects.\n" 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: - board additionalProperties: false properties: board: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - board board_object_collection: 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: - board_object_collection moment: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - moment rich_text_document: 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: - rich_text_document example: data: id: 7f71cfc6-5ac2-43cb-b28b-21851007e039 type: board_object_collection attributes: created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' position: 0 title: Sub-board collection of ideas description: null hide_empty_table: false relationships: board: data: id: e5398d78-c404-4e78-9676-f425c3fe6260 type: board created_by_user: data: id: d1c1091a-1f64-411e-883e-016a0dbb0a27 type: user board_objects: data: - id: 04adc136-81b4-4830-8dfd-dbbce9369bcf type: board_object '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 '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: - Boards operationId: DeleteBoardObjectCollectionV3 summary: Delete an Object Collection. security: - oauth2: - offline_access - api_key: [] parameters: - name: board_object_collection_id in: path required: true description: The ID of the Board Object Collection. schema: type: string format: uuid responses: '204': description: The Board Collection was successfully deleted. '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 '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 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