Skip to content

List Lead Statuses

GET
/integrations/crm-sync/leads/statuses

The org’s Salesforce Lead.Status picklist, minus the converted ones.

Read this before setting status_qualified / status_unqualified on a push. Lead.Status is an OPEN picklist: Salesforce stores whatever the API sends, so a typo does not fail - it creates a new status nobody meant to have. Converted statuses are filtered out because setting one through a push would silently convert the lead.

Salesforce only. Any other provider is a 400.

Authorizations

Parameters

Query Parameters

connection_id
required

A Salesforce connection.

string

A Salesforce connection.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

The org’s Salesforce Lead.Status picklist.

Open-shaped: each entry carries whatever Salesforce reports about the status, and the set of flags grows with their API. Converted statuses are already filtered out by the app - setting one through the push would silently convert leads.

object
default
Any of:
string
statuses
Array<object>
object
key
additional properties
any
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string