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 Labels API

## Labels OverviewIn Opal, Labels are a useful way of categorizing resources to be filtered or grouped.### Label InheritanceLabels 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**.

Opal Labels API is one of 79 APIs that Opal publishes on the 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.

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

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

4 operations 2 paths 0 schemas 1 DELETE1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Opal Labels API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 1 scope. An API key is passed in the header as Session-Token (api_key).

  • 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/…
  • api_key — (Deprecated) This API also supports authentication via an API or session token set in the request headers.

Paths & Operations 4

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

Labels 4

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…

GET
/labels/v2
Find labels for a Workspace.
ReadLabelsV2 5 params → 200401404
POST
/labels/v2
Create a new label.
CreateLabelV2 body → 201400401409422
PATCH
/labels/v2/{label_id}
Update a label.
UpdateLabelV2 1 param body → 201400401404409422
DELETE
/labels/v2/{label_id}
Delete a label.
DeleteLabelV2 1 param → 204400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opal-labels-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 Labels 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.