Get Collection By ID
curl --request GET \
--url https://api.zixflow.com/api/v1/collections/{collectionId}import requests
url = "https://api.zixflow.com/api/v1/collections/{collectionId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.zixflow.com/api/v1/collections/{collectionId}', 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/{collectionId}",
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/{collectionId}"
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/{collectionId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zixflow.com/api/v1/collections/{collectionId}")
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"
}
}
{
"status": false,
"message": "No token provided"
}
Collections
Get Collection By ID
This endpoint returns a collection
GET
/
api
/
v1
/
collections
/
{collectionId}
Get Collection By ID
curl --request GET \
--url https://api.zixflow.com/api/v1/collections/{collectionId}import requests
url = "https://api.zixflow.com/api/v1/collections/{collectionId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.zixflow.com/api/v1/collections/{collectionId}', 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/{collectionId}",
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/{collectionId}"
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/{collectionId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zixflow.com/api/v1/collections/{collectionId}")
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"
}
}
{
"status": false,
"message": "No token provided"
}
Path Params
string
required
A unique identifier for the list, allowing for precise referencing.
API Response Description:
Upon querying your collection endpoint, the API returns a structured response containing information about the requested collection. 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.”
object
An Object containing details of the available collections.
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"
}
}
{
"status": false,
"message": "No token provided"
}