Skip to main content
GET
/
api
/
v1
/
lists
/
{listId}
Get List By ID
curl --request GET \
  --url https://api.zixflow.com/api/v1/lists/{listId}
import requests

url = "https://api.zixflow.com/api/v1/lists/{listId}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.zixflow.com/api/v1/lists/{listId}', 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/{listId}",
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/{listId}"

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/{listId}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.zixflow.com/api/v1/lists/{listId}")

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": "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"
}

Path Params

listId
string
required
A unique identifier for the list, allowing for precise referencing.

API Response Description:

status
boolean
Indicates the success or failure of the list retrieval. In this case, true signifies a successful operation.
message
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.”
data
object
Detailed information about the selected List:
{   
    "status": true,
    "message": "Collection 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"
}