GET
/
api
/
v1
/
attributes
/
{target}
/
{targetId}
/
{attributeId}
Get Attribute By ID
curl --request GET \
  --url https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId} \
  --header 'Authorization: Bearer <token>'
{
    "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
    }
}

​
Description

This API endpoint allows the retrieval of details for a specific attribute identified by its unique ID. The attribute provides 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.
​
attributeId
string
required
The unique identifier for the attribute, allowing for precise referencing.

​
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 the attribute details.
​
data
object
An object containing details of the retrieved attribute:
{
    "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
    }
}