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"
}
Attributes
Get List Of Attributes
This endpoint retrieves the list of attributes associated with a collection or list.
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
string
required
Specifies the target type, which can be either “collection” or “list.”
string
required
A unique identifier for the target, either a collection ID or a list ID,
depending on the target type.
Response
boolean
Indicates the success or failure of the attribute retrieval. In this case,
true signifies a successful operation.
string
Provides a human-readable message accompanying the response. In this instance,
it confirms the successful retrieval of attributes with the message “success.”
array_object
An array containing details of the retrieved attributes. For each attribute in
the data array:
Show data
Show data
string
A unique identifier for the attribute, allowing for precise referencing.
string
The API key name used to store data in the collection or list for this
field.
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.
string
The human-readable name of the field.
object
Configuration settings for the attribute, including currency display type,
currency code, record reference, AI wizard, and date display type.
Show config
Show config
string
Accepted values: “code,” “name,” “narrowSymbol,” “symbol.” Specifies
how currency should be displayed.
string
The currency code (e.g., “EUR,” “GBP,” “USD,” “CAD,” “AUD”).
array_string
An array of collection ids connected to this attribute.
string
The AI wizard field prompt.
string
Defines how to display the date field.
string
The default value for the attribute.
string
A description providing additional information about the attribute.
boolean
Indicates whether the attribute is archived (true/false).
boolean
Indicates whether the default value is enabled for the attribute
(true/false).
boolean
Indicates whether the attribute is editable (true/false).
boolean
Indicates whether the attribute supports multiple selections (true/false).
boolean
Indicates whether the attribute is required (true/false).
boolean
Indicates whether the attribute is a system attribute (true/false).
boolean
Indicates whether the attribute values must be unique (true/false).
string
The validation type for the attribute. Possible values include “none,”
“email,” “url,” “phone,” “customRegex.”
{
"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"
}
⌘I