Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
version: 3.0.0
title: Opal API (⚠️ WIP) Moment 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: Moment Custom Fields
paths:
/moments/v3/{moment_id}/moment_custom_fields:
get:
tags:
- Moment Custom Fields
operationId: ReadMomentCustomFieldsV3
summary: Get Moment Custom Fields available to the authenticated user.
security:
- oauth2:
- offline_access
- api_key: []
parameters:
- name: moment_id
in: path
required: true
description: The ID of the Moment.
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
- moment
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 Moment Custom Fields.
content:
application/json:
schema:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
title: moment_custom_field
type: object
required:
- id
- type
- attributes
- relationships
additionalProperties: false
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- moment_custom_field
attributes:
type: object
additionalProperties: false
properties:
text_value:
type:
- string
- 'null'
description: 'The value for a Custom Field on a Moment if it''s a String custom field datatype.
'
date_value:
type:
- string
- 'null'
format: date-time
description: 'An RFC 3339 date-time for a custom field on a moment using the ‘Date’
datatype.
'
hash_value:
type:
- object
- 'null'
description: 'The value for a Custom Field on a Moment if it''s a value which can be
represented as a JSON object of the following known types.
'
oneOf:
- enum:
- null
- type: object
title: Single Select Value (V1)
additionalProperties: false
properties:
id:
type: string
description: The ID of the single select option.
- type: object
title: Multiple Select Options (V1)
additionalProperties: false
properties:
ids:
type: array
items:
type: string
format: uuid
description: 'List of IDs for multi-select options that are chosen/enabled for the given Custom Field.
'
- type: object
title: Users Select Value (V1)
additionalProperties: false
properties:
user_ids:
type: array
items:
type: string
format: uuid
description: 'List of user UUIDs that are selected for the users select custom field.
'
group_ids:
type: array
items:
type: string
format: uuid
description: 'List of user group UUIDs that are selected for the users select custom field.
'
- type: object
title: URL Value (V1)
additionalProperties: false
properties:
url:
type: string
description: The HTTP address for the web resource.
label:
type:
- string
- 'null'
description: The friendly display value.
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
- moment
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
moment:
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:
- moment
users:
type: object
required:
- data
additionalProperties: false
properties:
data:
type: array
items:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- user
groups:
type: object
required:
- data
additionalProperties: false
properties:
data:
type: array
items:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- user_group
included:
type: array
items:
oneOf:
- 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:
# --- truncated at 32 KB (204 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/opal/refs/heads/main/openapi/opal-moment-custom-fields-api-openapi.yml