Skip to main content
GET
/
api
/
v1
/
attributes
/
{target}
/
{targetId}
Get List Of Attributes
curl --request GET \
  --url https://api.zixflow.com/api/v1/attributes/{target}/{targetId}
import requests

url = "https://api.zixflow.com/api/v1/attributes/{target}/{targetId}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.zixflow.com/api/v1/attributes/{target}/{targetId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zixflow.com/api/v1/attributes/{target}/{targetId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.zixflow.com/api/v1/attributes/{target}/{targetId}"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.zixflow.com/api/v1/attributes/{target}/{targetId}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.zixflow.com/api/v1/attributes/{target}/{targetId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
    "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...
    ]
}
{
  "status": false,
  "message": "No token provided"
}

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:
{
    "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...
    ]
}
{
  "status": false,
  "message": "No token provided"
}