# Opal Labels API

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

Opal Labels 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 Labels. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

## Labels Overview In Opal, Labels are a useful way of categorizing resources to be filtered or grouped. ### Label Inheritance Labels follow StoryFirst inheritance rules. This means that **Content** inherits labels from **Moment** which inherits labels from **Story**. **Content** also inherits labels from the selected **Account**. If a **Moment** belongs to more than one **Story**, labels are inherited from all related stories (i.e. the labels inherited comprise the union of the labels for each story). For example: ![Label Inheritance](/api/documentation/static/svg/label_inheritance) Inheritance is "broken" when one or more labels is explicitly set directly on a resource. For example, if you set the labels _x_ and _y_ for a piece of **Content**, that content will then only be considered to have exactly the labels _x_ and _y_ and no longer the labels of its parent **Moment** or **Story** (or associated **Account**). The default behavior of the Opal Web frontend is actually such that when **Content** gets explicit direct labels, it takes on all existing inherited labels _and_ the new direct labels, but it does not gain new inherited labels going forward. This behavior is achieved by requesting all of the current labels for that **Content** and then explicitly setting the new labels to all existing inherited labels plus the new labels. ![Broken Label Inheritance at Content](/api/documentation/static/svg/label_inheritance_broken) Inheritance can also be broken by explicitly setting labels on a **Moment**. Using our _x_ and _y_ labels again: ![Broken Label Inheritance at Moment](/api/documentation/static/svg/label_inheritance_broken_at_moment) Notice that **Content** still inherits from **Moment** and **Account** even when **Moment** stops inheriting from **Story**.

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/opal/refs/heads/main/openapi/opal-labels-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

Labels

---

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