How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Opal Custom Fields API

## Custom Fields OverviewCustom 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.- **[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).- **[Custom Field Types](#tag/Custom-Field-Types)**: The available types of custom fields which an admin can create, such as a Date input.- **[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 useon this resource is determined by the [Custom Field Type](#tag/Custom-Field-Types) that the [Custom Fields](#tag/Custom-Fields) is based on. - ``text_value``: A primitive string - ``date_value``: An ISO8601 date-time - ``hash_value``: A JSON object for [Custom Fields](#tag/Custom-Fields) which store complex datastructures### PairingMultiselect 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.Both 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.

Opal Custom Fields API is one of 79 APIs that Opal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Fields. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 2 paths. It is described by OpenAPI 3.2.0, at version 3.0.0.

Requests are made against a single base URL, https://login.ouropal.com.

5 operations 2 paths 0 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0.0
Base URL
https://login.ouropal.com
Authentication
OAuth 2.0, OAuth 2.0, API Key, API Key
Resource Areas
1

Authentication & Security 4

Opal Custom Fields API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 1 scope. It supports OAuth 2.0 (anonymous_oauth) using the clientCredentials flow, exposing 1 scope. An API key is passed in the header as Session-Token (api_key). An API key is passed in the cookie as share_token (presentation_share_cookie).

  • oauth2 — This API uses OAuth 2.0 with the authorization code grant flow. You can find more detailed authentication instructions in the [Authentication Strategies](/api/…
  • anonymous_oauth — 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. The…
  • api_key — (Deprecated) This API also supports authentication via an API or session token set in the request headers.
  • presentation_share_cookie — 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 th…

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Custom Fields 5

Custom Fields Overview Custom 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…

GET
/loupe/v3/custom_fields
Get CustomFields available to the authenticated user.
ReadCustomFieldsV3 3 params → 200400401422
POST
/loupe/v3/custom_fields
Create a new CustomField.
CreateCustomFieldV3 1 param body → 201400401404409422
GET
/loupe/v3/custom_fields/{custom_field_id}
Get a CustomField.
ReadCustomFieldV3 2 params → 200401403404
PATCH
/loupe/v3/custom_fields/{custom_field_id}
Update an existing CustomField.
UpdateCustomFieldV3 2 params body → 200400401404409422
DELETE
/loupe/v3/custom_fields/{custom_field_id}
Delete a CustomField.
DeleteCustomFieldV3 1 param → 204400401422

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opal-custom-fields-api-openapi.yml Raw ↑

Other APIs Opal publishes across the network.

Opal Accounts API
Opal Activities API
Opal Annotations API
Opal Asset Reference Options API
Opal Asset Reference Usage Rights Options API
Opal Asset References API
Opal Assets API
Opal Block Connectors API
Opal Block Custom Field Values API
Opal Block Duplication API
Opal Blocks API
Opal Board Collaborators API
Where this information came from

This is an independent, third-party profile of Opal Custom Fields API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.