Get List Of Attribute Options

curl --request GET \
  --url https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}/options

import requests

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

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}/options', 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}/options",
  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}/options"

	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}/options")
  .asString();

require 'uri'
require 'net/http'

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

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 option list fetched successfully",
    "data": [
        {
            "_id": "64ad815b273e66dae1afe124",
            "attributeId": "64ad815b273e66dae1afe121",
            "color": "#dbeddb",
            "name": "Deliverable",
            "isArchived": false,
            "order": 2
        },
        {
            "_id": "64ad815b273e66dae1afe125",
            "attributeId": "64ad815b273e66dae1afe121",
            "color": "#ffe2dd",
            "name": "Invalid",
            "isArchived": false,
            "order": 3
        },
        {
            "_id": "64ad815b273e66dae1afe126",
            "attributeId": "64ad815b273e66dae1afe121",
            "color": "#fdecc8",
            "name": "Risky",
            "isArchived": false,
            "order": 4
        }
    ]
}

{
  "status": false,
  "message": "No token provided"
}

GET

api

attributes

{target}

{targetId}

{attributeId}

options

Get List Of Attribute Options

curl --request GET \
  --url https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}/options

import requests

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

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}/options', 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}/options",
  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}/options"

	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}/options")
  .asString();

require 'uri'
require 'net/http'

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

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 option list fetched successfully",
    "data": [
        {
            "_id": "64ad815b273e66dae1afe124",
            "attributeId": "64ad815b273e66dae1afe121",
            "color": "#dbeddb",
            "name": "Deliverable",
            "isArchived": false,
            "order": 2
        },
        {
            "_id": "64ad815b273e66dae1afe125",
            "attributeId": "64ad815b273e66dae1afe121",
            "color": "#ffe2dd",
            "name": "Invalid",
            "isArchived": false,
            "order": 3
        },
        {
            "_id": "64ad815b273e66dae1afe126",
            "attributeId": "64ad815b273e66dae1afe121",
            "color": "#fdecc8",
            "name": "Risky",
            "isArchived": false,
            "order": 4
        }
    ]
}

{
  "status": false,
  "message": "No token provided"
}

Description

This API endpoint allows the retrieval of options associated with select or multiselect attributes. The options provide additional information or categorization for the specified attribute.

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 select or multiselect attribute for which options are to be fetched.

Response

boolean

Indicates the success or failure of the 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 options with the message “Attribute option list fetched successfully.”

array_object

An array containing details of the fetched attribute options. For each option in the data array:

Show data

string

A unique identifier for the attribute option, allowing for precise referencing.

string

The ID of the associated attribute to which the option belongs.

string

Hex color code representing the color associated with the option.

string

The name of the attribute option.

boolean

Indicates whether the option is archived (true/false).

integer

The order or ranking of the option.

{
    "status": true,
    "message": "Attribute option list fetched successfully",
    "data": [
        {
            "_id": "64ad815b273e66dae1afe124",
            "attributeId": "64ad815b273e66dae1afe121",
            "color": "#dbeddb",
            "name": "Deliverable",
            "isArchived": false,
            "order": 2
        },
        {
            "_id": "64ad815b273e66dae1afe125",
            "attributeId": "64ad815b273e66dae1afe121",
            "color": "#ffe2dd",
            "name": "Invalid",
            "isArchived": false,
            "order": 3
        },
        {
            "_id": "64ad815b273e66dae1afe126",
            "attributeId": "64ad815b273e66dae1afe121",
            "color": "#fdecc8",
            "name": "Risky",
            "isArchived": false,
            "order": 4
        }
    ]
}

{
  "status": false,
  "message": "No token provided"
}

Get List By ID Update Attribute Option

API Documentation

OTPflow Message

Whatsapp Campaign

RCS Campaign

SMS Campaign

Email Campaign

Campaign Report

Collections

Lists

Attributes

Collection Records

List Entries

Activity / Task

Workspace Members

Get List Of Attribute Options

Description

Path

Response

​Description

​Path

​Response

Description

Path

Response