Get List of Collection Records
curl --request POST \
--url https://api.zixflow.com/api/v1/collection-records/{collectionId}/query \
--header 'Content-Type: application/json' \
--data '
{
"filter": {},
"sort": [
{}
],
"limit": 123,
"offset": 123
}
'import requests
url = "https://api.zixflow.com/api/v1/collection-records/{collectionId}/query"
payload = {
"filter": {},
"sort": [{}],
"limit": 123,
"offset": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({filter: {}, sort: [{}], limit: 123, offset: 123})
};
fetch('https://api.zixflow.com/api/v1/collection-records/{collectionId}/query', 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/collection-records/{collectionId}/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
],
'sort' => [
[
]
],
'limit' => 123,
'offset' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zixflow.com/api/v1/collection-records/{collectionId}/query"
payload := strings.NewReader("{\n \"filter\": {},\n \"sort\": [\n {}\n ],\n \"limit\": 123,\n \"offset\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zixflow.com/api/v1/collection-records/{collectionId}/query")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {},\n \"sort\": [\n {}\n ],\n \"limit\": 123,\n \"offset\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zixflow.com/api/v1/collection-records/{collectionId}/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {},\n \"sort\": [\n {}\n ],\n \"limit\": 123,\n \"offset\": 123\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "success",
"data": [
{
"name": "Test Record",
"firstName": "Test",
"lastName": "Record",
"emails": [
"user@zixflow.com"
],
"phoneNumbers": [
"592965223",
"9176639301"
],
"company": {
"_id": "64b60314e7cca0f47d780544",
"name": "Zixflow",
"avatar": ""
},
"jobTitle": "Developer",
"description": "",
"address": "Mumbai, India",
"emailValidation": {
"_id": "64ad815b273e66dae1afe124",
"color": "#dbeddb",
"name": "Deliverable",
"isArchived": false,
"order": 2
},
"facebook": "",
"instagram": "",
"linkedin": "",
"twitter": "",
"lastInteraction": "2023-11-06T02:34:45.405Z",
"timezone": {
"_id": "64ad82ba273e66dae1b04689",
"color": "#e3e2e0",
"name": "Pacific/Niue",
"isArchived": false,
"order": 1
},
"source": {
"_id": "64ad815b273e66dae1afe141",
"color": "#fadec9",
"name": "Manually created",
"isArchived": false,
"order": 1
},
"owner": {
"_id": "64411b92cc16b5b0b858cc5f",
"name": "Agent Account",
"avatar": "",
"email": "dummy@outlook.com"
},
"share": [ ],
"createdAt": "2023-07-14T07:55:43.517Z",
"apiCustomAttribute": "Custom data",
"apiPipeline": {
"_id": "6520b88e4f7b6dea01cf9b7b",
"name": "Stage 2",
"color": "#02b55c",
"order": 2,
"isArchived": false,
"timeInStatus": null,
"celebrationEnabled": false,
"statusType": "normal"
},
"apiPipeline1": {
"_id": "64ae5870a3325d97495572f2",
"name": "Stage 1",
"color": "#5e6ad2",
"isArchived": false,
"timeInStatus": 0,
"celebrationEnabled": false,
"statusType": "normal"
},
"apiNumber1": 20,
"apiNumber2": 30
}
]
}
{
"status": false,
"message": "No token provided"
}
Collection Records
Get List of Collection Records
This endpoint returns all records data of selected collection
POST
/
api
/
v1
/
collection-records
/
{collectionId}
/
query
Get List of Collection Records
curl --request POST \
--url https://api.zixflow.com/api/v1/collection-records/{collectionId}/query \
--header 'Content-Type: application/json' \
--data '
{
"filter": {},
"sort": [
{}
],
"limit": 123,
"offset": 123
}
'import requests
url = "https://api.zixflow.com/api/v1/collection-records/{collectionId}/query"
payload = {
"filter": {},
"sort": [{}],
"limit": 123,
"offset": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({filter: {}, sort: [{}], limit: 123, offset: 123})
};
fetch('https://api.zixflow.com/api/v1/collection-records/{collectionId}/query', 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/collection-records/{collectionId}/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
],
'sort' => [
[
]
],
'limit' => 123,
'offset' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zixflow.com/api/v1/collection-records/{collectionId}/query"
payload := strings.NewReader("{\n \"filter\": {},\n \"sort\": [\n {}\n ],\n \"limit\": 123,\n \"offset\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zixflow.com/api/v1/collection-records/{collectionId}/query")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {},\n \"sort\": [\n {}\n ],\n \"limit\": 123,\n \"offset\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zixflow.com/api/v1/collection-records/{collectionId}/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {},\n \"sort\": [\n {}\n ],\n \"limit\": 123,\n \"offset\": 123\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "success",
"data": [
{
"name": "Test Record",
"firstName": "Test",
"lastName": "Record",
"emails": [
"user@zixflow.com"
],
"phoneNumbers": [
"592965223",
"9176639301"
],
"company": {
"_id": "64b60314e7cca0f47d780544",
"name": "Zixflow",
"avatar": ""
},
"jobTitle": "Developer",
"description": "",
"address": "Mumbai, India",
"emailValidation": {
"_id": "64ad815b273e66dae1afe124",
"color": "#dbeddb",
"name": "Deliverable",
"isArchived": false,
"order": 2
},
"facebook": "",
"instagram": "",
"linkedin": "",
"twitter": "",
"lastInteraction": "2023-11-06T02:34:45.405Z",
"timezone": {
"_id": "64ad82ba273e66dae1b04689",
"color": "#e3e2e0",
"name": "Pacific/Niue",
"isArchived": false,
"order": 1
},
"source": {
"_id": "64ad815b273e66dae1afe141",
"color": "#fadec9",
"name": "Manually created",
"isArchived": false,
"order": 1
},
"owner": {
"_id": "64411b92cc16b5b0b858cc5f",
"name": "Agent Account",
"avatar": "",
"email": "dummy@outlook.com"
},
"share": [ ],
"createdAt": "2023-07-14T07:55:43.517Z",
"apiCustomAttribute": "Custom data",
"apiPipeline": {
"_id": "6520b88e4f7b6dea01cf9b7b",
"name": "Stage 2",
"color": "#02b55c",
"order": 2,
"isArchived": false,
"timeInStatus": null,
"celebrationEnabled": false,
"statusType": "normal"
},
"apiPipeline1": {
"_id": "64ae5870a3325d97495572f2",
"name": "Stage 1",
"color": "#5e6ad2",
"isArchived": false,
"timeInStatus": 0,
"celebrationEnabled": false,
"statusType": "normal"
},
"apiNumber1": 20,
"apiNumber2": 30
}
]
}
{
"status": false,
"message": "No token provided"
}
Description
This API endpoint enables the retrieval of collection records data. The structure of the collection record data is dynamic and varies depending on the collection, with no fixed response keys within the data.Path
string
required
A unique identifier for the collection.
Body
object
An object that will eventually allow users to define specific criteria for
filtering data. Currently, it is an empty object, indicating that no filtering
is applied at this time.
array
An array that will eventually enable users to specify sorting criteria for the
data. It is currently empty, implying that no sorting is applied in the
current context.
number
required
he number of records to be returned, set to 10 in this instance. This
parameter restricts the response to a specific quantity of records.
number
required
The starting point from which the records are to be fetched within the entire
dataset. In this case, it is set to 0, indicating that retrieval should
commence from the beginning of the dataset.
Response
boolean
Indicates the success or failure of the response. 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 record with the message “success”
array_object
The structure of the collection record data is dynamic and varies depending on
the collection, with no fixed response keys within the data.
{
"status": true,
"message": "success",
"data": [
{
"name": "Test Record",
"firstName": "Test",
"lastName": "Record",
"emails": [
"user@zixflow.com"
],
"phoneNumbers": [
"592965223",
"9176639301"
],
"company": {
"_id": "64b60314e7cca0f47d780544",
"name": "Zixflow",
"avatar": ""
},
"jobTitle": "Developer",
"description": "",
"address": "Mumbai, India",
"emailValidation": {
"_id": "64ad815b273e66dae1afe124",
"color": "#dbeddb",
"name": "Deliverable",
"isArchived": false,
"order": 2
},
"facebook": "",
"instagram": "",
"linkedin": "",
"twitter": "",
"lastInteraction": "2023-11-06T02:34:45.405Z",
"timezone": {
"_id": "64ad82ba273e66dae1b04689",
"color": "#e3e2e0",
"name": "Pacific/Niue",
"isArchived": false,
"order": 1
},
"source": {
"_id": "64ad815b273e66dae1afe141",
"color": "#fadec9",
"name": "Manually created",
"isArchived": false,
"order": 1
},
"owner": {
"_id": "64411b92cc16b5b0b858cc5f",
"name": "Agent Account",
"avatar": "",
"email": "dummy@outlook.com"
},
"share": [ ],
"createdAt": "2023-07-14T07:55:43.517Z",
"apiCustomAttribute": "Custom data",
"apiPipeline": {
"_id": "6520b88e4f7b6dea01cf9b7b",
"name": "Stage 2",
"color": "#02b55c",
"order": 2,
"isArchived": false,
"timeInStatus": null,
"celebrationEnabled": false,
"statusType": "normal"
},
"apiPipeline1": {
"_id": "64ae5870a3325d97495572f2",
"name": "Stage 1",
"color": "#5e6ad2",
"isArchived": false,
"timeInStatus": 0,
"celebrationEnabled": false,
"statusType": "normal"
},
"apiNumber1": 20,
"apiNumber2": 30
}
]
}
{
"status": false,
"message": "No token provided"
}
⌘I