openapi: 3.2.0 info: version: 3.0.0 title: Opal API (⚠️ WIP) Custom Fields 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: Custom Fields description: "## Custom Fields Overview\n\nCustom Fields let you create custom inputs, the value of which can then be associated with a Moment, and allow your users to track dimensions based on your specific needs.\n\n- **[Custom Fields](#tag/Custom-Fields)**: An admin within a workspace can create a custom field to store new attributes on a [Moment](#tag/Moments/operation/CreateMomentV3).\n- **[Custom Field Types](#tag/Custom-Field-Types)**: The available types of custom fields which an admin can create, such as a Date input.\n- **[Moment Custom Fields](#tag/Moment-Custom-Fields)**: This resource lets one assign a ``value`` to the given Custom Field for the given Moment. Note that the expected attribute to use\non this resource is determined by the [Custom Field Type](#tag/Custom-Field-Types) that the [Custom Fields](#tag/Custom-Fields) is based on.\n - ``text_value``: A primitive string\n - ``date_value``: An ISO8601 date-time\n - ``hash_value``: A JSON object for [Custom Fields](#tag/Custom-Fields) which store complex data structures\n\n### Pairing\n\nMultiselect custom fields can be paired with [label sets](/api/documentation/v2#tag/Label-Sets) (`paired_label_set`), with the field’s options paired to the label set’s labels (`paired_label`). Once this pairing is established, the application will automatically do bidirectional syncing: choosing the multiselect’s options will apply the corresponding labels to the moment, and vice versa.\n\nBoth systems are supported, and the syncing should behave seamlessly, but at some point we will sunset the label system in favor of custom fields. We encourage using custom fields for new development.\n" paths: /loupe/v3/custom_fields: get: tags: - Custom Fields operationId: ReadCustomFieldsV3 summary: Get CustomFields 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: description: 'This is a mandatory filter for the /index endpoint. The ID of the workspace to which results should be filtered. For example, `filter[workspace_id]=798ac6d9-b3fc-4155-88ee-237f43f3404b` will fetch all resources associated with workspace `798ac6d9-b3fc-4155-88ee-237f43f34 ' type: array items: type: string format: uuid is_deactivated: type: boolean description: 'An optional true/false value indicating whether to filter on deactivated custom fields. ' id: type: string format: uuid description: 'An optional comma-separated string of UUIDs of the custom field to filter on. For example, `filter[id]=6b3ac6da-014e-4d6d-adc8-8b57adbff129,bda8ea26-2393-4378-a1dc-5ef7715f8015` will fetch only custom fields with the given IDs. ' custom_field_type.system_type: type: array items: type: string enum: - singleSelect - multiSelect - textarea - url - date - usersSelect description: 'An optional comma-separated string of system types for the custom field type to filter on. For example, `filter[custom_field_type.system_type]=singleSelect,multiSelect` will fetch only custom fields with the specified system types. ' 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: - custom_field_type - active_options - active_options.custom_field_color - deleted_options - deleted_options.custom_field_color style: form explode: false - name: page description: Specify an offset and limit for pagination in: query required: false schema: type: object properties: limit: type: integer default: 50 offset: type: integer style: deepObject explode: true responses: '200': description: A collection of CustomFields. content: application/json: schema: type: object required: - data - meta properties: data: type: array items: title: custom_field type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field attributes: type: object required: - description - display_name - is_deactivated - is_color_disabled - is_cascading - is_system_generated - metadata - created_at - updated_at additionalProperties: false properties: display_name: type: string description: 'The display name which will appear in the Opal application UI where used. ' description: type: - string - 'null' description: A plain text description of the custom field. is_deactivated: type: boolean description: 'A true/false value indicating whether this custom field is available for use within the Opal application. Note that this is separate from deleting the custom field. ' is_color_disabled: type: boolean description: 'Controls whether color relationships defined on options are displayed in the UI. When true, colors are hidden without removing the underlying color relationship settings. ' is_cascading: type: boolean description: 'PROPOSED: Indicates if blocks whose block_type has this custom_field enabled will inherit the values set for this custom field from its nearest ancestor block. Setting explicit values for this custom_field on a block will override inherited values. ' is_system_generated: type: boolean default: false readOnly: true description: 'Whether this field was auto-generated by the system rather than created by a user. Such fields currently cannot be renamed or deleted, though this may change in the future. Relevant for fields like the ‘Status’ single-select.' metadata: type: - object - 'null' deprecated: true description: 'You **SHOULD NOT** read this data. Instead, you **SHOULD** add `active_options` (and, if relevant, `deleted_options`) to the `custom_fields` request’s `include` query, and use the included `custom_field_option` resources. Explanation: serializing a few attributes from relationships in the `metadata` attribute was convenient for internal use while the `custom_field` resource was in development, but it’s not compliant with JSON:API, and the `include` approach is superior anyhow as allows callers full control over what data is included. `metadata/options` also has a different implementation than `custom_field_option` resources, so there’s some risk the two representations will become inconsistent.' oneOf: - title: Empty Object type: - object - 'null' additionalProperties: false description: 'The empty object for custom fields based on custom field types which have no configurable settings. ' - title: Single Select Metadata (V1) type: object required: - options properties: options: type: array items: type: object required: - id - display_name - position properties: id: type: string description: The ID of the option. Must be globally unique and a UUID. display_name: type: string description: The display value for this option. Must be unique across non-deleted siblings. position: type: integer description: The ordinal position of this option. Must be unique across non-deleted siblings. deleted_at: type: - string - 'null' format: date-time description: 'An ISO8601 date-time value, which will remove the given option from being usable. Once an option is created, it cannot be outright removed from the system. Instead, it can be deactivated by setting this value to a date-time value. One can set this to a value to remove the option from being usable, or null to restore it and make it usable again. Note that setting this to null will only be successful if doing so does not clobber the position or name of another non-deleted sibling. ' relationships: type: object additionalProperties: false properties: custom_field_color: allOf: - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_color description: 'A relationship to a color for this option. Can be omitted (no color), included with null data (explicitly no color), or included with valid color data. ' paired_label: allOf: - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label description: 'A relationship to a label that’s been paired with this option. ' created_at: type: string format: date-time description: An ISO8601 date-time representing the entity's creation date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time representing the entity's most recent updated date-time. readOnly: true relationships: type: object required: - custom_field_type - workspace - active_options - deleted_options - creator additionalProperties: false properties: active_options: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_option deleted_options: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_option custom_field_type: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_type creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user paired_label_set: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - label_set workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace included: type: array items: oneOf: - title: custom_field_type type: object required: - id - type - attributes additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_type attributes: type: object required: - system_type - display_name - description - schema - schema_version - datatype - created_at - updated_at additionalProperties: false properties: system_type: type: string description: The input type that this custom field represents. display_name: type: string description: The friendly label for this custom field type. description: type: - string - 'null' description: A longer description explaining the use case of this input type. schema: type: object description: "JSON metadata describing among other things the property names, \ndata types, and required fields that are configurable for this given\nCustom Field Type. Here, required fields would indicate properties which\nmust be configured by the admin at the time of Custom Field creation.\n" schema_version: type: integer description: An integer representing the given major version of this Custom Field Type's schema. datatype: type: string description: The underlying primitive datatype (e.g., String, or Date). 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 - title: custom_field_option type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_option attributes: type: object required: - created_at - deleted_at - display_name - position - 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 deleted_at: type: - string - 'null' format: date-time description: An ISO8601 date-time value, which will remove the given option from being usable. Once an option is created, it cannot be outright removed from the system. Instead, it can be deactivated by setting this value to a date-time value. One can set this to a value to remove the option from being usable, or null to restore it and make it usable again. Note that setting this to null will only be successful if doing so does not clobber the position or name of another non-deleted sibling. display_name: type: string description: The display value for this option. Must be unique across non-deleted siblings. position: type: integer description: The ordinal position of this option. Must be unique across non-deleted siblings. updated_at: type: string format: date-time description: An ISO8601 date-time representing the entity's most recent updated date-time. readOnly: true relationships: type: object required: - custom_field additionalProperties: false properties: custom_field: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field custom_field_color: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_color paired_label: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label - title: custom_field_color type: object required: - id - type - attributes additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_color attributes: type: object required: - color - is_system_generated - created_at - updated_at additionalProperties: false properties: color: type: - string - 'null' description: A color in hex format. position: type: number description: The order in which the color will appear when rendered in a list. is_system_generated: type: boolean default: false readOnly: true description: 'Whether this field was auto-generated by the system rather than created by a user.' 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 - title: workspace type: object required: - id - type - attributes - relationships - links additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace meta: type: - object - 'null' description: Metadata around the Workspace object properties: user_is_member: type: boolean description: Boolean that represents whether the requesting user is a member of the workspace. attributes: type: object required: - created_at - name - slug - updated_at - start_of_week - timezone - legacy_id additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true legacy_id: type: string description: A legacy ID that can be used with `v2` API endpoints. name: type: string description: The name of the workspace. slug: type: - string - 'null' description: The slug for the Workspace. This is a url-safe name for the Workspace. start_of_week: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 description: 'The default start weekday index for the week view Calendar and for Plans. Specifies the days in a week, 0 to 6 (Sunday to Saturday). 0 (Sunday) is the default. With regards to the week view Calendar, values greater than 1 will be considered the same as 1.' timezone: type: string description: The IANA time zone identifier for the default time zone used when creating resources in the workspace (e.g. America/New_York). updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - logo - workspace_defaults additionalProperties: false properties: logo: 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 workspace_defaults: 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_defaults links: type: object additionalProperties: false required: - v2_request properties: v2_request: type: string format: uri 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: a366316c-5061-46ae-94a0-3a118a8e4a1e type: custom_field attributes: display_name: Product Description description: A description of the product is_deactivated: false is_color_disabled: false is_cascading: false is_system_generated: false metadata: null options: - display_name: Option 1 id: 61fda0c8-0969-46e8-8aa9-8bc2fd928d83 position: 1 updated_at: '2020-09-11T15:27:01.881-08:00' created_at: '2020-09-11T15:27:01.881-08:00' deleted_at: '2020-09-11T15:27:01.881-08:00' - display_name: Option 2 id: d41899b4-b7a4-4280-9c96-4d7078b06128 position: 2 updated_at: '2020-09-11T15:27:01.881-08:00' created_at: '2020-09-11T15:27:01.881-08:00' created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' relationships: custom_field_type: data: id: 61fda0c8-0969-46e8-8aa9-8bc2fd928d83 type: custom_field_type workspace: data: id: 801ba99f-f5d1-441c-8cc7-fc61acc6a8f7 type: workspace creator: data: id: 801ba99f-f5d1-441c-8cc7-fc61acc6a8f7 type: user active_options: data: - id: 61fda0c8-0969-46e8-8aa9-8bc2fd928d83 type: custom_field_option deleted_options: data: - id: d41899b4-b7a4-4280-9c96-4d7078b06128 type: custom_field_option paired_label_set: data: id: 9e97b24c-b5d9-4d2a-9677-4d339312ee70 type: label_set '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: - Custom Fields operationId: CreateCustomFieldV3 summary: Create a new CustomField. 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: - custom_field_type - active_options - active_options.custom_field_color - deleted_options - deleted_options.custom_field_color style: form explode: false requestBody: content: application/json: schema: type: object required: - data properties: data: type: object required: - type - attributes - relationships properties: type: type: string enum: - custom_field attributes: type: object required: - display_name - metadata properties: display_name: type: string description: 'The display name which will appear in the Opal application UI where used. ' description: type: - string - 'null' description: A plain text description of the custom field. is_deactivated: type: boolean description: 'A true/false value indicating whether this custom field is available for use within the Opal application. Note that this is separate from deleting the custom field. ' is_color_disabled: type: boolean description: 'Controls whether color relationships defined on options are displayed in the UI. When true, colors are hidden without removing the underlying color relationship settings. ' is_cascading: type: boolean description: 'PROPOSED: Indicates if blocks whose block_type has this custom_field enabled will inherit the values set for this custom field from its nearest ancestor block. Setting explicit values for this custom_field on a block will override inherited values. ' metadata: type: - object - 'null' oneOf: - title: Empty Object type: - object - 'null' additionalProperties: false description: 'The empty object for custom fields based on custom field types which have no configurable settings. ' - title: Single Select Metadata (V1) type: object required: - options properties: options: type: array items: type: object required: - id - display_name - position properties: id: type: string description: The ID of the option. Must be unique across all sibling options. display_name: type: string description: The display value for this option. position: type: integer description: The ordinal position of this option relative to its siblings. Must be unique. deleted_at: type: - string - 'null' format: date-time description: 'An ISO8601 date-time value, which will remove the given option from being usable. Once an option is created, it cannot be outright removed from the system. Instead, it can be deactivated by setting this value to a date-time value. One can set this to a value to remove the option from being usable, or null to restore it and make it usable again. Note that setting this to null will only be successful if doing so does not clobber the position or name of another option. ' relationships: type: object additionalProperties: false properties: custom_field_color: description: 'A relationship to a color for this option. Can be omitted (no color), included with null data (explicitly no color), or included with valid color data. ' type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_color relationships: type: object required: - custom_field_type - workspace properties: custom_field_type: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_type paired_label_set: 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: - label_set workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace responses: '201': description: A newly created CustomField resource. content: application/json: schema: type: object required: - data properties: data: title: custom_field type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field attributes: type: object required: - description - display_name - is_deactivated - is_color_disabled - is_cascading - is_system_generated - metadata - created_at - updated_at additionalProperties: false properties: display_name: type: string description: 'The display name which will appear in the Opal application UI where used. ' description: type: - string - 'null' description: A plain text description of the custom field. is_deactivated: type: boolean description: 'A true/false value indicating whether this custom field is available for use within the Opal application. Note that this is separate from deleting the custom field. ' is_color_disabled: type: boolean description: 'Controls whether color relationships defined on options are displayed in the UI. When true, colors are hidden without removing the underlying color relationship settings. ' is_cascading: type: boolean description: 'PROPOSED: Indicates if blocks whose block_type has this custom_field enabled will inherit the values set for this custom field from its nearest ancestor block. Setting explicit values for this custom_field on a block will override inherited values. ' is_system_generated: type: boolean default: false readOnly: true description: 'Whether this field was auto-generated by the system rather than created by a user. Such fields currently cannot be renamed or deleted, though this may change in the future. Relevant for fields like the ‘Status’ single-select.' metadata: type: - object - 'null' deprecated: true description: 'You **SHOULD NOT** read this data. Instead, you **SHOULD** add `active_options` (and, if relevant, `deleted_options`) to the `custom_fields` request’s `include` query, and use the included `custom_field_option` resources. Explanation: serializing a few attributes from relationships in the `metadata` attribute was convenient for internal use while the `custom_field` resource was in development, but it’s not compliant with JSON:API, and the `include` approach is superior anyhow as allows callers full control over what data is included. `metadata/options` also has a different implementation than `custom_field_option` resources, so there’s some risk the two representations will become inconsistent.' oneOf: - title: Empty Object type: - object - 'null' additionalProperties: false description: 'The empty object for custom fields based on custom field types which have no configurable settings. ' - title: Single Select Metadata (V1) type: object required: - options properties: options: type: array items: type: object required: - id - display_name - position properties: id: type: string description: The ID of the option. Must be globally unique and a UUID. display_name: type: string description: The display value for this option. Must be unique across non-deleted siblings. position: type: integer description: The ordinal position of this option. Must be unique across non-deleted siblings. deleted_at: type: - string - 'null' format: date-time description: 'An ISO8601 date-time value, which will remove the given option from being usable. Once an option is created, it cannot be outright removed from the system. Instead, it can be deactivated by setting this value to a date-time value. One can set this to a value to remove the option from being usable, or null to restore it and make it usable again. Note that setting this to null will only be successful if doing so does not clobber the position or name of another non-deleted sibling. ' relationships: type: object additionalProperties: false properties: custom_field_color: allOf: - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_color description: 'A relationship to a color for this option. Can be omitted (no color), included with null data (explicitly no color), or included with valid color data. ' paired_label: allOf: - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label description: 'A relationship to a label that’s been paired with this option. ' created_at: type: string format: date-time description: An ISO8601 date-time representing the entity's creation date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time representing the entity's most recent updated date-time. readOnly: true relationships: type: object required: - custom_field_type - workspace - active_options - deleted_options - creator additionalProperties: false properties: active_options: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_option deleted_options: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_option custom_field_type: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_type creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user paired_label_set: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - label_set workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace included: type: array items: oneOf: - title: custom_field_type type: object required: - id - type - attributes additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_type attributes: type: object required: - system_type - display_name - description - schema - schema_version - datatype - created_at - updated_at additionalProperties: false properties: system_type: type: string description: The input type that this custom field represents. display_name: type: string description: The friendly label for this custom field type. description: type: - string - 'null' description: A longer description explaining the use case of this input type. schema: type: object description: "JSON metadata describing among other things the property names, \ndata types, and required fields that are configurable for this given\nCustom Field Type. Here, required fields would indicate properties which\nmust be configured by the admin at the time of Custom Field creation.\n" schema_version: type: integer description: An integer representing the given major version of this Custom Field Type's schema. datatype: type: string description: The underlying primitive datatype (e.g., String, or Date). 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 - title: custom_field_option type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_option attributes: type: object required: - created_at - deleted_at - display_name - position - 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 deleted_at: type: - string - 'null' format: date-time description: An ISO8601 date-time value, which will remove the given option from being usable. Once an option is created, it cannot be outright removed from the system. Instead, it can be deactivated by setting this value to a date-time value. One can set this to a value to remove the option from being usable, or null to restore it and make it usable again. Note that setting this to null will only be successful if doing so does not clobber the position or name of another non-deleted sibling. display_name: type: string description: The display value for this option. Must be unique across non-deleted siblings. position: type: integer description: The ordinal position of this option. Must be unique across non-deleted siblings. updated_at: type: string format: date-time description: An ISO8601 date-time representing the entity's most recent updated date-time. readOnly: true relationships: type: object required: - custom_field additionalProperties: false properties: custom_field: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field custom_field_color: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_color paired_label: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label - title: custom_field_color type: object required: - id - type - attributes additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_color attributes: type: object required: - color - is_system_generated - created_at - updated_at additionalProperties: false properties: color: type: - string - 'null' description: A color in hex format. position: type: number description: The order in which the color will appear when rendered in a list. is_system_generated: type: boolean default: false readOnly: true description: 'Whether this field was auto-generated by the system rather than created by a user.' 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 - title: workspace type: object required: - id - type - attributes - relationships - links additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace meta: type: - object - 'null' description: Metadata around the Workspace object properties: user_is_member: type: boolean description: Boolean that represents whether the requesting user is a member of the workspace. attributes: type: object required: - created_at - name - slug - updated_at - start_of_week - timezone - legacy_id additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true legacy_id: type: string description: A legacy ID that can be used with `v2` API endpoints. name: type: string description: The name of the workspace. slug: type: - string - 'null' description: The slug for the Workspace. This is a url-safe name for the Workspace. start_of_week: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 description: 'The default start weekday index for the week view Calendar and for Plans. Specifies the days in a week, 0 to 6 (Sunday to Saturday). 0 (Sunday) is the default. With regards to the week view Calendar, values greater than 1 will be considered the same as 1.' timezone: type: string description: The IANA time zone identifier for the default time zone used when creating resources in the workspace (e.g. America/New_York). updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - logo - workspace_defaults additionalProperties: false properties: logo: 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 workspace_defaults: 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_defaults links: type: object additionalProperties: false required: - v2_request properties: v2_request: type: string format: uri example: data: id: a366316c-5061-46ae-94a0-3a118a8e4a1e type: custom_field attributes: display_name: Product Description description: A description of the product is_deactivated: false is_color_disabled: false is_cascading: false is_system_generated: false metadata: options: - display_name: Option 1 id: 61fda0c8-0969-46e8-8aa9-8bc2fd928d83 position: 1 updated_at: '2020-09-11T15:27:01.881-08:00' created_at: '2020-09-11T15:27:01.881-08:00' deleted_at: '2020-09-11T15:27:01.881-08:00' - display_name: Option 2 id: d41899b4-b7a4-4280-9c96-4d7078b06128 position: 2 updated_at: '2020-09-11T15:27:01.881-08:00' created_at: '2020-09-11T15:27:01.881-08:00' created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' relationships: custom_field_type: data: id: 61fda0c8-0969-46e8-8aa9-8bc2fd928d83 type: custom_field_type workspace: data: id: 801ba99f-f5d1-441c-8cc7-fc61acc6a8f7 type: workspace creator: data: id: 801ba99f-f5d1-441c-8cc7-fc61acc6a8f7 type: user active_options: data: - id: 61fda0c8-0969-46e8-8aa9-8bc2fd928d83 type: custom_field_option deleted_options: data: - id: d41899b4-b7a4-4280-9c96-4d7078b06128 type: custom_field_option paired_label_set: data: id: 9e97b24c-b5d9-4d2a-9677-4d339312ee70 type: label_set '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 /loupe/v3/custom_fields/{custom_field_id}: get: tags: - Custom Fields operationId: ReadCustomFieldV3 summary: Get a CustomField. security: - oauth2: - offline_access - api_key: [] parameters: - name: custom_field_id in: path required: true description: The ID of the CustomField. 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: - custom_field_type - active_options - active_options.custom_field_color - deleted_options - deleted_options.custom_field_color style: form explode: false responses: '200': description: The requested Custom Field content: application/json: schema: type: object required: - data properties: data: title: custom_field type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field attributes: type: object required: - description - display_name - is_deactivated - is_color_disabled - is_cascading - is_system_generated - metadata - created_at - updated_at additionalProperties: false properties: display_name: type: string description: 'The display name which will appear in the Opal application UI where used. ' description: type: - string - 'null' description: A plain text description of the custom field. is_deactivated: type: boolean description: 'A true/false value indicating whether this custom field is available for use within the Opal application. Note that this is separate from deleting the custom field. ' is_color_disabled: type: boolean description: 'Controls whether color relationships defined on options are displayed in the UI. When true, colors are hidden without removing the underlying color relationship settings. ' is_cascading: type: boolean description: 'PROPOSED: Indicates if blocks whose block_type has this custom_field enabled will inherit the values set for this custom field from its nearest ancestor block. Setting explicit values for this custom_field on a block will override inherited values. ' is_system_generated: type: boolean default: false readOnly: true description: 'Whether this field was auto-generated by the system rather than created by a user. Such fields currently cannot be renamed or deleted, though this may change in the future. Relevant for fields like the ‘Status’ single-select.' metadata: type: - object - 'null' deprecated: true description: 'You **SHOULD NOT** read this data. Instead, you **SHOULD** add `active_options` (and, if relevant, `deleted_options`) to the `custom_fields` request’s `include` query, and use the included `custom_field_option` resources. Explanation: serializing a few attributes from relationships in the `metadata` attribute was convenient for internal use while the `custom_field` resource was in development, but it’s not compliant with JSON:API, and the `include` approach is superior anyhow as allows callers full control over what data is included. `metadata/options` also has a different implementation than `custom_field_option` resources, so there’s some risk the two representations will become inconsistent.' oneOf: - title: Empty Object type: - object - 'null' additionalProperties: false description: 'The empty object for custom fields based on custom field types which have no configurable settings. ' - title: Single Select Metadata (V1) type: object required: - options properties: options: type: array items: type: object required: - id - display_name - position properties: id: type: string description: The ID of the option. Must be globally unique and a UUID. display_name: type: string description: The display value for this option. Must be unique across non-deleted siblings. position: type: integer description: The ordinal position of this option. Must be unique across non-deleted siblings. deleted_at: type: - string - 'null' format: date-time description: 'An ISO8601 date-time value, which will remove the given option from being usable. Once an option is created, it cannot be outright removed from the system. Instead, it can be deactivated by setting this value to a date-time value. One can set this to a value to remove the option from being usable, or null to restore it and make it usable again. Note that setting this to null will only be successful if doing so does not clobber the position or name of another non-deleted sibling. ' relationships: type: object additionalProperties: false properties: custom_field_color: allOf: - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_color description: 'A relationship to a color for this option. Can be omitted (no color), included with null data (explicitly no color), or included with valid color data. ' paired_label: allOf: - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label description: 'A relationship to a label that’s been paired with this option. ' created_at: type: string format: date-time description: An ISO8601 date-time representing the entity's creation date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time representing the entity's most recent updated date-time. readOnly: true relationships: type: object required: - custom_field_type - workspace - active_options - deleted_options - creator additionalProperties: false properties: active_options: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_option deleted_options: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_option custom_field_type: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_type creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user paired_label_set: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - label_set workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace included: type: array items: oneOf: - title: custom_field_type type: object required: - id - type - attributes additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_type attributes: type: object required: - system_type - display_name - description - schema - schema_version - datatype - created_at - updated_at additionalProperties: false properties: system_type: type: string description: The input type that this custom field represents. display_name: type: string description: The friendly label for this custom field type. description: type: - string - 'null' description: A longer description explaining the use case of this input type. schema: type: object description: "JSON metadata describing among other things the property names, \ndata types, and required fields that are configurable for this given\nCustom Field Type. Here, required fields would indicate properties which\nmust be configured by the admin at the time of Custom Field creation.\n" schema_version: type: integer description: An integer representing the given major version of this Custom Field Type's schema. datatype: type: string description: The underlying primitive datatype (e.g., String, or Date). 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 - title: custom_field_option type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_option attributes: type: object required: - created_at - deleted_at - display_name - position - 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 deleted_at: type: - string - 'null' format: date-time description: An ISO8601 date-time value, which will remove the given option from being usable. Once an option is created, it cannot be outright removed from the system. Instead, it can be deactivated by setting this value to a date-time value. One can set this to a value to remove the option from being usable, or null to restore it and make it usable again. Note that setting this to null will only be successful if doing so does not clobber the position or name of another non-deleted sibling. display_name: type: string description: The display value for this option. Must be unique across non-deleted siblings. position: type: integer description: The ordinal position of this option. Must be unique across non-deleted siblings. updated_at: type: string format: date-time description: An ISO8601 date-time representing the entity's most recent updated date-time. readOnly: true relationships: type: object required: - custom_field additionalProperties: false properties: custom_field: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field custom_field_color: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_color paired_label: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label - title: custom_field_color type: object required: - id - type - attributes additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_color attributes: type: object required: - color - is_system_generated - created_at - updated_at additionalProperties: false properties: color: type: - string - 'null' description: A color in hex format. position: type: number description: The order in which the color will appear when rendered in a list. is_system_generated: type: boolean default: false readOnly: true description: 'Whether this field was auto-generated by the system rather than created by a user.' 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 - title: workspace type: object required: - id - type - attributes - relationships - links additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace meta: type: - object - 'null' description: Metadata around the Workspace object properties: user_is_member: type: boolean description: Boolean that represents whether the requesting user is a member of the workspace. attributes: type: object required: - created_at - name - slug - updated_at - start_of_week - timezone - legacy_id additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true legacy_id: type: string description: A legacy ID that can be used with `v2` API endpoints. name: type: string description: The name of the workspace. slug: type: - string - 'null' description: The slug for the Workspace. This is a url-safe name for the Workspace. start_of_week: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 description: 'The default start weekday index for the week view Calendar and for Plans. Specifies the days in a week, 0 to 6 (Sunday to Saturday). 0 (Sunday) is the default. With regards to the week view Calendar, values greater than 1 will be considered the same as 1.' timezone: type: string description: The IANA time zone identifier for the default time zone used when creating resources in the workspace (e.g. America/New_York). updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - logo - workspace_defaults additionalProperties: false properties: logo: 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 workspace_defaults: 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_defaults links: type: object additionalProperties: false required: - v2_request properties: v2_request: type: string format: uri example: data: id: a366316c-5061-46ae-94a0-3a118a8e4a1e type: custom_field attributes: display_name: Product Description description: A description of the product is_deactivated: false is_color_disabled: false is_cascading: false is_system_generated: false metadata: options: - display_name: Option 1 id: 61fda0c8-0969-46e8-8aa9-8bc2fd928d83 position: 1 updated_at: '2020-09-11T15:27:01.881-08:00' created_at: '2020-09-11T15:27:01.881-08:00' deleted_at: '2020-09-11T15:27:01.881-08:00' - display_name: Option 2 id: d41899b4-b7a4-4280-9c96-4d7078b06128 position: 2 updated_at: '2020-09-11T15:27:01.881-08:00' created_at: '2020-09-11T15:27:01.881-08:00' created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' relationships: custom_field_type: data: id: 61fda0c8-0969-46e8-8aa9-8bc2fd928d83 type: custom_field_type workspace: data: id: 801ba99f-f5d1-441c-8cc7-fc61acc6a8f7 type: workspace creator: data: id: 801ba99f-f5d1-441c-8cc7-fc61acc6a8f7 type: user active_options: data: - id: 61fda0c8-0969-46e8-8aa9-8bc2fd928d83 type: custom_field_option deleted_options: data: - id: d41899b4-b7a4-4280-9c96-4d7078b06128 type: custom_field_option paired_label_set: data: id: 9e97b24c-b5d9-4d2a-9677-4d339312ee70 type: label_set '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: - Custom Fields operationId: UpdateCustomFieldV3 summary: Update an existing CustomField. security: - oauth2: - offline_access - api_key: [] parameters: - name: custom_field_id in: path required: true description: The ID of the CustomField. 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: - custom_field_type - active_options - active_options.custom_field_color - deleted_options - deleted_options.custom_field_color 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: - custom_field attributes: type: object properties: display_name: type: string description: 'The display name which will appear in the Opal application UI where used. ' description: type: - string - 'null' description: A plain text description of the custom field. is_deactivated: type: boolean description: 'A true/false value indicating whether this custom field is available for use within the Opal application. Note that this is separate from deleting the custom field. ' is_color_disabled: type: boolean description: 'Controls whether color relationships defined on options are displayed in the UI. When true, colors are hidden without removing the underlying color relationship settings. ' is_cascading: type: boolean description: 'PROPOSED: Indicates if blocks whose block_type has this custom_field enabled will inherit the values set for this custom field from its nearest ancestor block. Setting explicit values for this custom_field on a block will override inherited values. ' metadata: type: - object - 'null' oneOf: - title: Empty Object type: - object - 'null' additionalProperties: false description: 'The empty object for custom fields based on custom field types which have no configurable settings. ' - title: Single Select Metadata (V1) type: object properties: options: type: array items: type: object required: - id - display_name - position properties: id: type: string description: The ID of the option. Must be unique across all sibling options. display_name: type: string description: The display value for this option. position: type: integer description: The ordinal position of this option relative to its siblings. Must be unique. deleted_at: type: - string - 'null' format: date-time description: 'An ISO8601 date-time value, which will remove the given option from being usable. Once an option is created, it cannot be outright removed from the system. Instead, it can be deactivated by setting this value to a date-time value. One can set this to a value to remove the option from being usable, or null to restore it and make it usable again. ' relationships: type: object additionalProperties: false properties: custom_field_color: description: 'A relationship to a color for this option. Can be omitted (no color), included with null data (explicitly no color), or included with valid color data. ' type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_color relationships: type: object properties: paired_label_set: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - label_set responses: '200': description: An updated custom_field resource. content: application/json: schema: type: object required: - data properties: data: title: custom_field type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field attributes: type: object required: - description - display_name - is_deactivated - is_color_disabled - is_cascading - is_system_generated - metadata - created_at - updated_at additionalProperties: false properties: display_name: type: string description: 'The display name which will appear in the Opal application UI where used. ' description: type: - string - 'null' description: A plain text description of the custom field. is_deactivated: type: boolean description: 'A true/false value indicating whether this custom field is available for use within the Opal application. Note that this is separate from deleting the custom field. ' is_color_disabled: type: boolean description: 'Controls whether color relationships defined on options are displayed in the UI. When true, colors are hidden without removing the underlying color relationship settings. ' is_cascading: type: boolean description: 'PROPOSED: Indicates if blocks whose block_type has this custom_field enabled will inherit the values set for this custom field from its nearest ancestor block. Setting explicit values for this custom_field on a block will override inherited values. ' is_system_generated: type: boolean default: false readOnly: true description: 'Whether this field was auto-generated by the system rather than created by a user. Such fields currently cannot be renamed or deleted, though this may change in the future. Relevant for fields like the ‘Status’ single-select.' metadata: type: - object - 'null' deprecated: true description: 'You **SHOULD NOT** read this data. Instead, you **SHOULD** add `active_options` (and, if relevant, `deleted_options`) to the `custom_fields` request’s `include` query, and use the included `custom_field_option` resources. Explanation: serializing a few attributes from relationships in the `metadata` attribute was convenient for internal use while the `custom_field` resource was in development, but it’s not compliant with JSON:API, and the `include` approach is superior anyhow as allows callers full control over what data is included. `metadata/options` also has a different implementation than `custom_field_option` resources, so there’s some risk the two representations will become inconsistent.' oneOf: - title: Empty Object type: - object - 'null' additionalProperties: false description: 'The empty object for custom fields based on custom field types which have no configurable settings. ' - title: Single Select Metadata (V1) type: object required: - options properties: options: type: array items: type: object required: - id - display_name - position properties: id: type: string description: The ID of the option. Must be globally unique and a UUID. display_name: type: string description: The display value for this option. Must be unique across non-deleted siblings. position: type: integer description: The ordinal position of this option. Must be unique across non-deleted siblings. deleted_at: type: - string - 'null' format: date-time description: 'An ISO8601 date-time value, which will remove the given option from being usable. Once an option is created, it cannot be outright removed from the system. Instead, it can be deactivated by setting this value to a date-time value. One can set this to a value to remove the option from being usable, or null to restore it and make it usable again. Note that setting this to null will only be successful if doing so does not clobber the position or name of another non-deleted sibling. ' relationships: type: object additionalProperties: false properties: custom_field_color: allOf: - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_color description: 'A relationship to a color for this option. Can be omitted (no color), included with null data (explicitly no color), or included with valid color data. ' paired_label: allOf: - type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label description: 'A relationship to a label that’s been paired with this option. ' created_at: type: string format: date-time description: An ISO8601 date-time representing the entity's creation date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time representing the entity's most recent updated date-time. readOnly: true relationships: type: object required: - custom_field_type - workspace - active_options - deleted_options - creator additionalProperties: false properties: active_options: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_option deleted_options: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_option custom_field_type: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_type creator: title: User type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - user paired_label_set: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - label_set workspace: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace included: type: array items: oneOf: - title: custom_field_type type: object required: - id - type - attributes additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_type attributes: type: object required: - system_type - display_name - description - schema - schema_version - datatype - created_at - updated_at additionalProperties: false properties: system_type: type: string description: The input type that this custom field represents. display_name: type: string description: The friendly label for this custom field type. description: type: - string - 'null' description: A longer description explaining the use case of this input type. schema: type: object description: "JSON metadata describing among other things the property names, \ndata types, and required fields that are configurable for this given\nCustom Field Type. Here, required fields would indicate properties which\nmust be configured by the admin at the time of Custom Field creation.\n" schema_version: type: integer description: An integer representing the given major version of this Custom Field Type's schema. datatype: type: string description: The underlying primitive datatype (e.g., String, or Date). 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 - title: custom_field_option type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_option attributes: type: object required: - created_at - deleted_at - display_name - position - 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 deleted_at: type: - string - 'null' format: date-time description: An ISO8601 date-time value, which will remove the given option from being usable. Once an option is created, it cannot be outright removed from the system. Instead, it can be deactivated by setting this value to a date-time value. One can set this to a value to remove the option from being usable, or null to restore it and make it usable again. Note that setting this to null will only be successful if doing so does not clobber the position or name of another non-deleted sibling. display_name: type: string description: The display value for this option. Must be unique across non-deleted siblings. position: type: integer description: The ordinal position of this option. Must be unique across non-deleted siblings. updated_at: type: string format: date-time description: An ISO8601 date-time representing the entity's most recent updated date-time. readOnly: true relationships: type: object required: - custom_field additionalProperties: false properties: custom_field: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field custom_field_color: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_color paired_label: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label - title: custom_field_color type: object required: - id - type - attributes additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - custom_field_color attributes: type: object required: - color - is_system_generated - created_at - updated_at additionalProperties: false properties: color: type: - string - 'null' description: A color in hex format. position: type: number description: The order in which the color will appear when rendered in a list. is_system_generated: type: boolean default: false readOnly: true description: 'Whether this field was auto-generated by the system rather than created by a user.' 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 - title: workspace type: object required: - id - type - attributes - relationships - links additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - workspace meta: type: - object - 'null' description: Metadata around the Workspace object properties: user_is_member: type: boolean description: Boolean that represents whether the requesting user is a member of the workspace. attributes: type: object required: - created_at - name - slug - updated_at - start_of_week - timezone - legacy_id additionalProperties: false properties: created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true legacy_id: type: string description: A legacy ID that can be used with `v2` API endpoints. name: type: string description: The name of the workspace. slug: type: - string - 'null' description: The slug for the Workspace. This is a url-safe name for the Workspace. start_of_week: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 description: 'The default start weekday index for the week view Calendar and for Plans. Specifies the days in a week, 0 to 6 (Sunday to Saturday). 0 (Sunday) is the default. With regards to the week view Calendar, values greater than 1 will be considered the same as 1.' timezone: type: string description: The IANA time zone identifier for the default time zone used when creating resources in the workspace (e.g. America/New_York). updated_at: type: - string - 'null' format: date-time description: An ISO8601 date-time. readOnly: true relationships: type: object required: - logo - workspace_defaults additionalProperties: false properties: logo: 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 workspace_defaults: 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_defaults links: type: object additionalProperties: false required: - v2_request properties: v2_request: type: string format: uri example: data: id: a366316c-5061-46ae-94a0-3a118a8e4a1e type: custom_field attributes: display_name: Product Description description: A description of the product is_deactivated: false is_color_disabled: false is_cascading: false is_system_generated: false metadata: options: - display_name: Option 1 id: 61fda0c8-0969-46e8-8aa9-8bc2fd928d83 position: 1 updated_at: '2020-09-11T15:27:01.881-08:00' created_at: '2020-09-11T15:27:01.881-08:00' deleted_at: '2020-09-11T15:27:01.881-08:00' - display_name: Option 2 id: d41899b4-b7a4-4280-9c96-4d7078b06128 position: 2 updated_at: '2020-09-11T15:27:01.881-08:00' created_at: '2020-09-11T15:27:01.881-08:00' created_at: '2020-09-11T15:27:01.881-08:00' updated_at: '2020-09-11T15:27:01.881-08:00' relationships: custom_field_type: data: id: 61fda0c8-0969-46e8-8aa9-8bc2fd928d83 type: custom_field_type workspace: data: id: 801ba99f-f5d1-441c-8cc7-fc61acc6a8f7 type: workspace creator: data: id: 801ba99f-f5d1-441c-8cc7-fc61acc6a8f7 type: user active_options: data: - id: 61fda0c8-0969-46e8-8aa9-8bc2fd928d83 type: custom_field_option deleted_options: data: - id: d41899b4-b7a4-4280-9c96-4d7078b06128 type: custom_field_option paired_label_set: data: id: 9e97b24c-b5d9-4d2a-9677-4d339312ee70 type: label_set '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: - Custom Fields operationId: DeleteCustomFieldV3 summary: Delete a CustomField. security: - oauth2: - offline_access - api_key: [] parameters: - name: custom_field_id in: path required: true description: The ID of the CustomField. schema: type: string format: uuid responses: '204': description: The CustomField 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