Get List Of Collections
curl --request GET \
--url https://api.zixflow.com/api/v1/collectionsimport requests
url = "https://api.zixflow.com/api/v1/collections"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.zixflow.com/api/v1/collections', 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/collections",
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/collections"
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/collections")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zixflow.com/api/v1/collections")
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": "Collection fetched successfully",
"data": [
{
"_id": "652e506bf781c59be3825523",
"collectionType": "people",
"name": "People",
"slug": "people"
},
{
"_id": "652e506bf781c59be3825526",
"collectionType": "company",
"name": "Company",
"slug": "company"
},
{
"_id": "652e506bf781c59be3825528",
"collectionType": "deals",
"name": "Deals",
"slug": "deals"
}
]
}
{
"status": false,
"message": "No token provided"
}
Collections
Get List Of Collections
Lists all system and custom collections of your workspace.
GET
/
api
/
v1
/
collections
Get List Of Collections
curl --request GET \
--url https://api.zixflow.com/api/v1/collectionsimport requests
url = "https://api.zixflow.com/api/v1/collections"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.zixflow.com/api/v1/collections', 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/collections",
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/collections"
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/collections")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zixflow.com/api/v1/collections")
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": "Collection fetched successfully",
"data": [
{
"_id": "652e506bf781c59be3825523",
"collectionType": "people",
"name": "People",
"slug": "people"
},
{
"_id": "652e506bf781c59be3825526",
"collectionType": "company",
"name": "Company",
"slug": "company"
},
{
"_id": "652e506bf781c59be3825528",
"collectionType": "deals",
"name": "Deals",
"slug": "deals"
}
]
}
{
"status": false,
"message": "No token provided"
}
API Response Description:
Upon querying your collection endpoint, the API returns a structured response containing information about the available collections. Here’s a breakdown of the response:boolean
Indicates the success or failure of the collection 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 collection with the message
“Collection fetched successfully.”
array_object
An array containing details of the available collections. For each collection
in the data array:
Show data
Show data
string
A unique identifier for the collection, allowing for precise referencing.
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.
string
Specifies the type of the collection. For system-defined collections, it
will have values like “people,” “company,” or “deals.” For user-defined
collections, it will return “custom.”
{
"status": true,
"message": "Collection fetched successfully",
"data": [
{
"_id": "652e506bf781c59be3825523",
"collectionType": "people",
"name": "People",
"slug": "people"
},
{
"_id": "652e506bf781c59be3825526",
"collectionType": "company",
"name": "Company",
"slug": "company"
},
{
"_id": "652e506bf781c59be3825528",
"collectionType": "deals",
"name": "Deals",
"slug": "deals"
}
]
}
{
"status": false,
"message": "No token provided"
}