Skip to main content
GET
Get all lead statuses

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Query Parameters

search
string | null

The search query.

Maximum string length: 255
is_default
boolean | null

Filter by default status.

is_terminal
boolean | null

Whether this is a terminal status.

is_system
boolean | null

Whether this is a system-defined record.

sort_by
enum<string> | null

The field to sort by.

Available options:
sort_order,
name,
created_at,
updated_at
sort_order
enum<string> | null

The sort direction (asc or desc).

Available options:
asc,
desc
per_page
integer | null

The number of items per page.

Required range: 1 <= x <= 100
trashed
boolean | null

Include only soft-deleted records.

Response

Paginated set of LeadStatusResource

data
LeadStatusResource · object[]
required
meta
object
required