> ## 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.

# Get List Of Attribute Status Options

> This endpoint retrieves the list of options for status attributes.

#### 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

<ParamField path="target" type="string" required>
  Specifies the target type, which can be either "collection" or "list."
</ParamField>

<ParamField path="targetId" type="string" required>
  A unique identifier for the target, either a collection ID or a list ID, depending on the target type.
</ParamField>

<ParamField path="attributeId" type="string" required>
  The ID of the status attribute for which options are to be fetched.
</ParamField>

#### Response

<ResponseField name="status" type="boolean">
  Indicates the success or failure of the status option retrieval. In this case,
  true signifies a successful operation.
</ResponseField>

<ResponseField name="message" type="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."
</ResponseField>

<ResponseField name="data" type="array_object">
  An array containing details of the fetched attribute status options. For each option
  in the data array:

  <Expandable title="data">
    <ResponseField name="_id" type="string">
      A unique identifier for the attribute status option, allowing for precise referencing.
    </ResponseField>

    <ResponseField name="attributeId" type="string">
      The ID of the associated status attribute to which the option belongs.
    </ResponseField>

    <ResponseField name="name" type="string">
      The name of the attribute status option.
    </ResponseField>

    <ResponseField name="color" type="string">
      Hex color code representing the color associated with the status option.
    </ResponseField>

    <ResponseField name="isArchived" type="boolean">
      Indicates whether the status option is archived (true/false).
    </ResponseField>

    <ResponseField name="timeInStatus" type="integer">
      The time, in seconds, that items spend in this status option.
    </ResponseField>

    <ResponseField name="celebrationEnabled" type="boolean">
      Indicates whether celebration is enabled for this status option (true/false).
    </ResponseField>

    <ResponseField name="statusType" type="string">
      Specifies the type of status. It can be "normal" or other applicable types.
    </ResponseField>

    <ResponseField name="order" type="integer">
      The order or ranking of the status option.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json 200-Success theme={null}
  {
      "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
          }
      ]
  }
  ```

  ```json 401-Unauthorised theme={null}
  {
    "status": false,
    "message": "No token provided"
  }
  ```
</ResponseExample>