Skip to navigation

Fetch a single lead status

View as Markdown

Fetch a single lead status by its ID or its label. The id path param is matched against status IDs first, then against labels, ignoring case in both. Returns 404 if no status matches.

Authentication

AuthorizationBasic
Use your API key as the username and leave the password empty.
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
ID of the lead status, or its label. Labels are matched ignoring case, and only when no status has a matching ID.

Response

Successful response
colorenum or null
Color of the status badge in Close, or null if no color is set.
idstring

Unique ID of the lead status, prefixed with stat_.

labelstring

Name of the lead status, unique within the organization (ignoring case).

organization_idstring
ID of the organization the lead status belongs to.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error