Skip to main content
This schema describes objects returned by the Lead Label endpoints.

A custom label for categorizing and managing leads

​
id
string<uuid>
required
read-only

Unique identifier for the custom lead label

Example:

"01a1121d-fcc1-7dc4-9353-b02d08399b57"

​
timestamp_created
string<date-time>
required
read-only

Timestamp when the custom lead label was created

Example:

"2026-10-06T16:48:37.569Z"

​
created_by
null | string<uuid>
required

User ID of the creator of this label. Null when the label was created by an API key or an internal service

Example:

"01a1121d-fcc1-7dc4-9353-b02e2ea6b75e"

​
organization_id
string<uuid>
required
read-only

Organization ID that owns this custom lead label

Example:

"01a1121d-fcc1-7dc4-9353-b02f90ee8107"

​
label
string
required

Display label for the custom lead label

Example:

"Hot Lead"

​
interest_status_label
enum<string>
required

Interest status label associated with this label

Available options:
positive,
negative,
neutral
Example:

"positive"

​
interest_status
number
required
read-only

Interest status associated with this label. This is generated automatically by us.

Example:

1

​
description
null | string

Detailed description of the custom lead label purpose

Example:

"Used for marking high-priority leads"

​
use_with_ai
null | boolean

Whether this label should be used with AI features

Example:

false

​
access_grants
object[]
read-only

The access grants on this label, oldest first, each with the access type the member holds. Only present when resource ownership is enabled for the workspace.