Skip to content

support_status_get

Get one status of this product status dictionary by id, in the same shape a list element has.

Tool

support_status_get

Get one status of this product status dictionary by id, in the same shape a list element has.

Get one status of this product status dictionary by id, in the same shape a list element has. An archived status is returned like any other — hiding it is the list job, not this one. A status belonging to another product is reported as not found

Behavior

HTTP
GET /support/statuses/:id

Arguments

Name
Type
Required
Description
id
string
•
Status id

Response

Field
Type
Always
Description
id
string
•
Status id
name
string
•
Status name, unique within the product
color
string
•
Display colour as a hex string
order
integer
•
Sort order within the status dictionary
archived
boolean
•
Archived statuses stay readable but are not offered as targets
category
string
•
Lifecycle bucket the status belongs to

Try it

Get one status of this product status dictionary by id, in the same shape a list element has.

When to use

Get one status of this product status dictionary by id, in the same shape a list element has. An archived status is returned like any other — hiding it is the list job, not this one. A status belonging to another product is reported as not found

Example

Ask your agent something like this:

Get one status of this product status dictionary by id, in the same shape a list element has.

The agent will invoke support_status_get with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select