Get List of List Entries

curl --request POST \
  --url https://api.zixflow.com/api/v1/list-entries/{listId}/query \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": {},
  "sort": [
    {}
  ],
  "limit": 123,
  "offset": 123
}
'

import requests

url = "https://api.zixflow.com/api/v1/list-entries/{listId}/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/list-entries/{listId}/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/list-entries/{listId}/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/list-entries/{listId}/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/list-entries/{listId}/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/list-entries/{listId}/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": "List Entries fetched successfully",
    "data": [
        {
            "_id": "65321b9a05ca4dc48ed8b231",
            "owner": {
                "_id": "63d0e0b2eaa35b73f3b23450",
                "name": "Test User",
                "avatar": "",
                "email": "test@outlook.com"
            },
            "createdAt": "2023-10-20T06:18:02.403Z",
            "apiPipeline3": null
        }
    ]
}

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

POST

api

list-entries

{listId}

query

Get List of List Entries

curl --request POST \
  --url https://api.zixflow.com/api/v1/list-entries/{listId}/query \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": {},
  "sort": [
    {}
  ],
  "limit": 123,
  "offset": 123
}
'

import requests

url = "https://api.zixflow.com/api/v1/list-entries/{listId}/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/list-entries/{listId}/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/list-entries/{listId}/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/list-entries/{listId}/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/list-entries/{listId}/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/list-entries/{listId}/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": "List Entries fetched successfully",
    "data": [
        {
            "_id": "65321b9a05ca4dc48ed8b231",
            "owner": {
                "_id": "63d0e0b2eaa35b73f3b23450",
                "name": "Test User",
                "avatar": "",
                "email": "test@outlook.com"
            },
            "createdAt": "2023-10-20T06:18:02.403Z",
            "apiPipeline3": null
        }
    ]
}

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

Description

This API endpoint enables the retrieval of list entries. The structure of the list entries is dynamic and varies depending on the list and attributes, with no fixed response keys within the data.

Path

string

required

A unique identifier for the list.

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 entries to be returned, set to 10 in this instance. This parameter restricts the response to a specific quantity of entries.

number

required

The starting point from which the entries 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 entries with the message “List Entries fetched successfully”

array_object

The structure of the list entries is dynamic and varies depending on the list and attributes, with no fixed response keys within the data.

{
    "status": true,
    "message": "List Entries fetched successfully",
    "data": [
        {
            "_id": "65321b9a05ca4dc48ed8b231",
            "owner": {
                "_id": "63d0e0b2eaa35b73f3b23450",
                "name": "Test User",
                "avatar": "",
                "email": "test@outlook.com"
            },
            "createdAt": "2023-10-20T06:18:02.403Z",
            "apiPipeline3": null
        }
    ]
}

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

Delete Collection Record By ID Get List Entry By ID

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 List Entries

Description

Path

Body

Response

​Description

​Path

​Body

​Response

Description

Path

Body

Response