Fetch a single opportunity status
Fetch a single opportunity status by its ID. Returns 404 if no status in your organization has that ID.
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
id
ID of the opportunity status.
Query parameters
_fields
Comma-separated list of fields to include in the response.
Response
Successful response
id
Unique ID of the opportunity status, prefixed with stat_.
label
Name of the opportunity status, unique within its pipeline (ignoring case).
organization_id
ID of the organization the opportunity status belongs to.
type
Whether opportunities in this status are open (active) or closed (won or lost).
Allowed values:
pipeline_id
ID of the pipeline the opportunity status belongs to, prefixed with pipe_.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error