Skip to main content
GET
/
v1
/
labels
/
{labelName}
Get label
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/labels/{labelName} \
  --header 'Authorization: Bearer <token>'
{
  "name": "Production",
  "verified": true,
  "homepage": true,
  "usage_count": 12,
  "color": "#000000",
  "description": "Documents verified and in prod"
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
labelName
string
required

The label name. Lookup is case-insensitive.

URL-encode special characters (e.g., In%20Review for "In Review").

Response

Label details

A label for organizing and categorizing documents and folders

​
name
string

The label name (2-25 characters).

Names are case-insensitive: "Production" and "production" are considered the same.

Example:

"Production"

​
verified
boolean

Whether the label is verified/curated

Example:

true

​
homepage
boolean

Whether the label appears on the organization homepage

Example:

false

​
usage_count
integer

Total number of documents and folders using this label

Example:

12

​
color
string

Hex color for the label

Maximum string length: 9
Example:

"#0366d6"

​
description
string

Description of the label

Maximum string length: 500
Example:

"Documents based on dev schemas"