Skip to main content
GET
/
statuses
/
{statusId}
Get status
curl --request GET \
  --url https://inboxapp.com/api/v1/statuses/{statusId}
{
  "id": "<string>",
  "name": "<string>",
  "color": "#ef4444",
  "createdAt": "2023-11-07T05:31:56Z"
}

Path Parameters

statusId
string
required

The ID of the status to retrieve.

Response

200 - application/json

OK

id
string
required

Unique identifier for the status.

name
string
required

The display name of the status. Typically represents a stage in your sales pipeline.

color
string | null
required

Hex color code for the status (e.g., #10b981 for green). Null if no color is set.

Example:

"#ef4444"

createdAt
string<date-time>
required

The timestamp when this status was created.