Skip to main content
GET
/
api
/
v1
/
attributes
/
{target}
/
{targetId}
/
{attributeId}
/
options
Get List Of Attribute Options
curl --request GET \
  --url https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}/options
{
    "status": true,
    "message": "Attribute option list fetched successfully",
    "data": [
        {
            "_id": "64ad815b273e66dae1afe124",
            "attributeId": "64ad815b273e66dae1afe121",
            "color": "#dbeddb",
            "name": "Deliverable",
            "isArchived": false,
            "order": 2
        },
        {
            "_id": "64ad815b273e66dae1afe125",
            "attributeId": "64ad815b273e66dae1afe121",
            "color": "#ffe2dd",
            "name": "Invalid",
            "isArchived": false,
            "order": 3
        },
        {
            "_id": "64ad815b273e66dae1afe126",
            "attributeId": "64ad815b273e66dae1afe121",
            "color": "#fdecc8",
            "name": "Risky",
            "isArchived": false,
            "order": 4
        }
    ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.zixflow.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Description

This API endpoint allows the retrieval of options associated with select or multiselect attributes. The options provide additional information or categorization for the specified attribute.

​
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 select or multiselect attribute for which options are to be fetched.

​
Response

​
status
boolean
Indicates the success or failure of the 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 options with the message “Attribute option list fetched successfully.”
​
data
array_object
An array containing details of the fetched attribute options. For each option in the data array:
{
    "status": true,
    "message": "Attribute option list fetched successfully",
    "data": [
        {
            "_id": "64ad815b273e66dae1afe124",
            "attributeId": "64ad815b273e66dae1afe121",
            "color": "#dbeddb",
            "name": "Deliverable",
            "isArchived": false,
            "order": 2
        },
        {
            "_id": "64ad815b273e66dae1afe125",
            "attributeId": "64ad815b273e66dae1afe121",
            "color": "#ffe2dd",
            "name": "Invalid",
            "isArchived": false,
            "order": 3
        },
        {
            "_id": "64ad815b273e66dae1afe126",
            "attributeId": "64ad815b273e66dae1afe121",
            "color": "#fdecc8",
            "name": "Risky",
            "isArchived": false,
            "order": 4
        }
    ]
}