GET
/
api
/
v1
/
attributes
/
{target}
/
{targetId}
/
{attributeId}
/
status
curl --request GET \
  --url https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}/status \
  --header 'Authorization: Bearer <token>'
{
    "status": true,
    "message": "Attribute status list fetched successfully",
    "data": [
        {
            "_id": "64ae57b3a3325d9749556eee",
            "attributeId": "64ae57b3a3325d9749556eeb",
            "name": "Stage 1",
            "color": "#e57b00",
            "isArchived": false,
            "timeInStatus": 0,
            "celebrationEnabled": false,
            "statusType": "normal",
            "__v": 0,
            "order": 1
        },
        {
            "_id": "6520b88e4f7b6dea01cf9b7b",
            "attributeId": "64ae57b3a3325d9749556eeb",
            "name": "Stage 2",
            "color": "#02b55c",
            "order": 2,
            "isArchived": false,
            "timeInStatus": null,
            "celebrationEnabled": false,
            "statusType": "normal",
            "__v": 0
        }
    ]
}

​
Description

This API endpoint allows the retrieval of options associated with status attributes. Status attributes are used to define different stages or states that an item can go through in a collection or list.

​
Path

​
target
string
required

Specifies the target type, which can be either “collection” or “list.”

​
targetId
string
required

A unique identifier for the target, either a collection ID or a list ID, depending on the target type.

​
attributeId
string
required

The ID of the status attribute for which options are to be fetched.

​
Response

​
status
boolean

Indicates the success or failure of the status option retrieval. In this case, true signifies a successful operation.

​
message
string

Provides a human-readable message accompanying the response. In this instance, it confirms the successful retrieval of attribute status options with the message “Attribute status list fetched successfully.”

​
data
array_object

An array containing details of the fetched attribute status options. For each option in the data array:

{
    "status": true,
    "message": "Attribute status list fetched successfully",
    "data": [
        {
            "_id": "64ae57b3a3325d9749556eee",
            "attributeId": "64ae57b3a3325d9749556eeb",
            "name": "Stage 1",
            "color": "#e57b00",
            "isArchived": false,
            "timeInStatus": 0,
            "celebrationEnabled": false,
            "statusType": "normal",
            "__v": 0,
            "order": 1
        },
        {
            "_id": "6520b88e4f7b6dea01cf9b7b",
            "attributeId": "64ae57b3a3325d9749556eeb",
            "name": "Stage 2",
            "color": "#02b55c",
            "order": 2,
            "isArchived": false,
            "timeInStatus": null,
            "celebrationEnabled": false,
            "statusType": "normal",
            "__v": 0
        }
    ]
}