GET
/
api
/
v1
/
attributes
/
{target}
/
{targetId}
Authorization
Path
curl --request GET \
  --url https://api.zixflow.com/api/v1/attributes/{target}/{targetId} \
  --header 'Authorization: <authorization>'
{
    "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...
    ]
}

​
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

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.

​
Response

status
boolean

Indicates the success or failure of the attribute 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 attributes with the message “success.”

data
array_object

An array containing details of the retrieved attributes. For each attribute in the data array:

Delete Attribute Status OptionGet Attribute By ID