Get List Of Attribute Status Options
curl --request GET \
--url https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}/statusimport requests
url = "https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}/status"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}/status', 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}/{attributeId}/status",
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}/{attributeId}/status"
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}/{attributeId}/status")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}/status")
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": "Attribute status list fetched successfully",
"data": [
{
"_id": "64ae57b3a3325d9749556eee",
"attributeId": "64ae57b3a3325d9749556eeb",
"name": "Stage 1",
"color": "#e57b00",
"isArchived": false,
"timeInStatus": 0,
"celebrationEnabled": false,
"statusType": "normal",
"__v": 0,
"order": 1
},
{
"_id": "6520b88e4f7b6dea01cf9b7b",
"attributeId": "64ae57b3a3325d9749556eeb",
"name": "Stage 2",
"color": "#02b55c",
"order": 2,
"isArchived": false,
"timeInStatus": null,
"celebrationEnabled": false,
"statusType": "normal",
"__v": 0
}
]
}
{
"status": false,
"message": "No token provided"
}
Attribute Status
Get List Of Attribute Status Options
This endpoint retrieves the list of options for status attributes.
GET
/
api
/
v1
/
attributes
/
{target}
/
{targetId}
/
{attributeId}
/
status
Get List Of Attribute Status Options
curl --request GET \
--url https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}/statusimport requests
url = "https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}/status"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}/status', 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}/{attributeId}/status",
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}/{attributeId}/status"
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}/{attributeId}/status")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}/status")
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": "Attribute status list fetched successfully",
"data": [
{
"_id": "64ae57b3a3325d9749556eee",
"attributeId": "64ae57b3a3325d9749556eeb",
"name": "Stage 1",
"color": "#e57b00",
"isArchived": false,
"timeInStatus": 0,
"celebrationEnabled": false,
"statusType": "normal",
"__v": 0,
"order": 1
},
{
"_id": "6520b88e4f7b6dea01cf9b7b",
"attributeId": "64ae57b3a3325d9749556eeb",
"name": "Stage 2",
"color": "#02b55c",
"order": 2,
"isArchived": false,
"timeInStatus": null,
"celebrationEnabled": false,
"statusType": "normal",
"__v": 0
}
]
}
{
"status": false,
"message": "No token provided"
}
Description
This API endpoint allows the retrieval of options associated with status attributes. Status attributes are used to define different stages or states that an item can go through in 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.
string
required
The ID of the status attribute for which options are to be fetched.
Response
boolean
Indicates the success or failure of the status option 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 attribute status options with the message
“Attribute status list fetched successfully.”
array_object
An array containing details of the fetched attribute status options. For each option
in the data array:
Show data
Show data
string
A unique identifier for the attribute status option, allowing for precise referencing.
string
The ID of the associated status attribute to which the option belongs.
string
The name of the attribute status option.
string
Hex color code representing the color associated with the status option.
boolean
Indicates whether the status option is archived (true/false).
integer
The time, in seconds, that items spend in this status option.
boolean
Indicates whether celebration is enabled for this status option (true/false).
string
Specifies the type of status. It can be “normal” or other applicable types.
integer
The order or ranking of the status option.
{
"status": true,
"message": "Attribute status list fetched successfully",
"data": [
{
"_id": "64ae57b3a3325d9749556eee",
"attributeId": "64ae57b3a3325d9749556eeb",
"name": "Stage 1",
"color": "#e57b00",
"isArchived": false,
"timeInStatus": 0,
"celebrationEnabled": false,
"statusType": "normal",
"__v": 0,
"order": 1
},
{
"_id": "6520b88e4f7b6dea01cf9b7b",
"attributeId": "64ae57b3a3325d9749556eeb",
"name": "Stage 2",
"color": "#02b55c",
"order": 2,
"isArchived": false,
"timeInStatus": null,
"celebrationEnabled": false,
"statusType": "normal",
"__v": 0
}
]
}
{
"status": false,
"message": "No token provided"
}