Get List of Lists
curl --request GET \
--url https://api.zixflow.com/api/v1/listsimport requests
url = "https://api.zixflow.com/api/v1/lists"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.zixflow.com/api/v1/lists', 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/lists",
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/lists"
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/lists")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zixflow.com/api/v1/lists")
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": "List fetched successfully.",
"data": [
{
"_id": "653bbba76ecd501e8dcbbb5d",
"name": "Alumni",
"slug": "Alumni",
"emoji": "🚀",
"collectionId": "652e506bf781c59be3825523",
"duplicationAllowed": true,
"collection": {
"_id": "652e506bf781c59be3825523",
"collectionType": "people",
"name": "People",
"slug": "people"
}
}
]
}
{
"status": false,
"message": "No token provided"
}
Lists
Get List of Lists
This endpoint returns all lists
GET
/
api
/
v1
/
lists
Get List of Lists
curl --request GET \
--url https://api.zixflow.com/api/v1/listsimport requests
url = "https://api.zixflow.com/api/v1/lists"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.zixflow.com/api/v1/lists', 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/lists",
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/lists"
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/lists")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zixflow.com/api/v1/lists")
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": "List fetched successfully.",
"data": [
{
"_id": "653bbba76ecd501e8dcbbb5d",
"name": "Alumni",
"slug": "Alumni",
"emoji": "🚀",
"collectionId": "652e506bf781c59be3825523",
"duplicationAllowed": true,
"collection": {
"_id": "652e506bf781c59be3825523",
"collectionType": "people",
"name": "People",
"slug": "people"
}
}
]
}
{
"status": false,
"message": "No token provided"
}
API Response Description:
Upon querying your list endpoint, the API returns a structured response containing information about the available lists. Here’s a breakdown of the response:boolean
Indicates the success or failure of the list 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 the list with the message
“List fetched successfully.”
array_object
An array containing details of the available lists. For each list
in the data array:
Show data
Show data
string
A unique identifier for the list, allowing for precise referencing.
string
The human-readable name of the list, providing a clear
identification.
string
A unique identifier for the list, useful for programmatic
identification and differentiation.
string
An emoji associated with the list for visual identification.
string
The unique identifier of the collection to which the list belongs,
facilitating collection identification.
boolean
Defines whether duplicate records can be added inside the list.
object
Details about the collection from which the list is created:
Show collection
Show collection
string
A unique identifier for the collection, allowing for precise referencing.
string
Specifies the type of the collection, such as “people,” “company,” or “deals.”
string
The human-readable name of the collection, providing a clear identification.
string
A unique identifier for the collection, useful for programmatic
identification and differentiation.
{
"status": true,
"message": "List fetched successfully.",
"data": [
{
"_id": "653bbba76ecd501e8dcbbb5d",
"name": "Alumni",
"slug": "Alumni",
"emoji": "🚀",
"collectionId": "652e506bf781c59be3825523",
"duplicationAllowed": true,
"collection": {
"_id": "652e506bf781c59be3825523",
"collectionType": "people",
"name": "People",
"slug": "people"
}
}
]
}
{
"status": false,
"message": "No token provided"
}
⌘I