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

> This endpoint retrieves the list of attributes associated with a collection or list.

#### Description

This API endpoint allows the retrieval of attributes associated with a specified target, which can be either a "collection" or "list." Attributes provide information about the nature and characteristics of data stored within 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>

#### Response

<ResponseField name="status" type="boolean">
  Indicates the success or failure of the attribute 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 attributes with the message "success."
</ResponseField>

<ResponseField name="data" type="array_object">
  An array containing details of the retrieved attributes. For each attribute in
  the data array:

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

    <ResponseField name="apiKeyName" type="string">
      The API key name used to store data in the collection or list for this
      field.
    </ResponseField>

    <ResponseField name="inputType" type="string">
      Defines the input type or nature of the field. Possible values include
      text, number, checkbox, currency, date, timestamp, rating, status, select,
      multiselect, record-reference, actor-reference, domain, file, ai-wizard,
      email-address, phone-number.
    </ResponseField>

    <ResponseField name="name" type="string">
      The human-readable name of the field.
    </ResponseField>

    <ResponseField name="config" type="object">
      Configuration settings for the attribute, including currency display type,
      currency code, record reference, AI wizard, and date display type.

      <Expandable title="config">
        <ResponseField name="currencyDisplayType" type="string">
          Accepted values: "code," "name," "narrowSymbol," "symbol." Specifies
          how currency should be displayed.
        </ResponseField>

        <ResponseField name="currencyCode" type="string">
          The currency code (e.g., "EUR," "GBP," "USD," "CAD," "AUD").
        </ResponseField>

        <ResponseField name="recordReference" type="array_string">
          An array of collection ids connected to this attribute.
        </ResponseField>

        <ResponseField name="aiWizard" type="string">
          The AI wizard field prompt.
        </ResponseField>

        <ResponseField name="dateDisplayType" type="string">
          Defines how to display the date field.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="defaultValue" type="string">
      The default value for the attribute.
    </ResponseField>

    <ResponseField name="description" type="string">
      A description providing additional information about the attribute.
    </ResponseField>

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

    <ResponseField name="isDefaultValueEnabled" type="boolean">
      Indicates whether the default value is enabled for the attribute
      (true/false).
    </ResponseField>

    <ResponseField name="isEditable" type="boolean">
      Indicates whether the attribute is editable (true/false).
    </ResponseField>

    <ResponseField name="isMultiSelect" type="boolean">
      Indicates whether the attribute supports multiple selections (true/false).
    </ResponseField>

    <ResponseField name="isRequired" type="boolean">
      Indicates whether the attribute is required (true/false).
    </ResponseField>

    <ResponseField name="isSystemAttribute" type="boolean">
      Indicates whether the attribute is a system attribute (true/false).
    </ResponseField>

    <ResponseField name="isUnique" type="boolean">
      Indicates whether the attribute values must be unique (true/false).
    </ResponseField>

    <ResponseField name="validation" type="string">
      The validation type for the attribute. Possible values include "none,"
      "email," "url," "phone," "customRegex."
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json 200-Success theme={null}
  {
      "status": true,
      "message": "success",
      "data": [
          {
              "_id": "64ad815b273e66dae1afe10f",
              "apiKeyName": "name",
              "inputType": "text",
              "name": "Name",
              "config": {
                  "currencyDisplayType": null,
                  "currencyCode": null,
                  "recordReference": [],
                  "aiWizard": null,
                  "dateDisplayType": null
              },
              "defaultValue": null,
              "description": "",
              "isArchived": false,
              "isDefaultValueEnabled": false,
              "isEditable": true,
              "isMultiSelect": false,
              "isRequired": false,
              "isSystemAttribute": true,
              "isUniuqe": false,
              "validation": "none",
              "isUnique": false
          },
          // Additional attributes...
      ]
  }
  ```

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