Skip to main content
GET
/
v1
/
labels
List Labels
curl --request GET \
  --url https://api.us.lexful.app/v1/labels \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-ID: <api-key>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "is_system": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "color": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

​
Authorization
string
header
required

Bearer token

​
X-Account-ID
string
header
required

Account ID

Query Parameters

​
name
string

Filter by name (partial match, case-insensitive)

​
parent_id
string<uuid>

Filter by parent label ID (use "null" string for root labels)

​
is_parent
boolean

Filter for parent labels (true) or leaf labels (false)

​
is_system
boolean

Filter by system labels

​
include_deleted
boolean

Include soft-deleted labels

​
limit
number
default:100
Required range: 1 <= x <= 1000
​
offset
number
default:0
Required range: x >= 0
​
sort
string

Comma-separated fields to sort by (e.g., "name,created_at")

​
order
string

Comma-separated sort directions - ASC or DESC (e.g., "ASC,DESC")

Response

Default Response

​
items
object[]
required
​
total
number
required

Total number of items available

​
limit
number
required

Number of items returned

​
offset
number
required

Number of items skipped