# Opal Custom Fields API

**Canonical:** https://apis.io/apis/opal/opal-custom-fields-api/  
**Provider:** Opal — https://apis.io/providers/opal/  
**Base URL:** https://login.ouropal.com  
**Documentation:** https://login.ouropal.com/api/documentation/v2

Opal Custom Fields API is one of 79 APIs that [Opal](https://apis.io/providers/opal/) publishes on the [APIs.io](https://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.

## 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 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 use on 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 data structures ### Pairing Multiselect 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.

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/opal/refs/heads/main/openapi/opal-custom-fields-api-openapi.yml
- **Documentation** — https://login.ouropal.com/api/documentation/v2
- **APIReference** — https://login.ouropal.com/api/documentation/v2
- **Documentation** — https://login.ouropal.com/api/documentation/v3
- **APIReference** — https://login.ouropal.com/api/documentation/v3
- **Documentation** — https://login.ouropal.com/api/documentation/asgard_bff

## Other Opal APIs (12)

- [Opal Accounts API](https://apis.io/apis/opal/opal-accounts-api/)
- [Opal Activities API](https://apis.io/apis/opal/opal-activities-api/)
- [Opal Annotations API](https://apis.io/apis/opal/opal-annotations-api/)
- [Opal Asset Reference Options API](https://apis.io/apis/opal/opal-asset-reference-options-api/)
- [Opal Asset Reference Usage Rights Options API](https://apis.io/apis/opal/opal-asset-reference-usage-rights-options-api/)
- [Opal Asset References API](https://apis.io/apis/opal/opal-asset-references-api/)
- [Opal Assets API](https://apis.io/apis/opal/opal-assets-api/)
- [Opal Block Connectors API](https://apis.io/apis/opal/opal-block-connectors-api/)
- [Opal Block Custom Field Values API](https://apis.io/apis/opal/opal-block-custom-field-values-api/)
- [Opal Block Duplication API](https://apis.io/apis/opal/opal-block-duplication-api/)
- [Opal Blocks API](https://apis.io/apis/opal/opal-blocks-api/)
- [Opal Board Collaborators API](https://apis.io/apis/opal/opal-board-collaborators-api/)

## Tags

Custom Fields

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/opal/opal-custom-fields-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/opal/.