Skip to main content
GET
/
lists
Get all lists
curl --request GET \
  --url https://api.breakcold.com/rest/lists \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.breakcold.com/rest/lists"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.breakcold.com/rest/lists', 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.breakcold.com/rest/lists",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$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.breakcold.com/rest/lists"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	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.breakcold.com/rest/lists")
  .header("X-API-KEY", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.breakcold.com/rest/lists")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "order": 123,
    "emoji": "<string>",
    "description": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "can_be_delete": true,
    "deleted_at": "<string>",
    "is_deleted": true,
    "favorite": true,
    "id_space": "<string>",
    "attribute_definitions_order": [
      "<string>"
    ],
    "ai_instructions": null,
    "ai_rules": null,
    "ai_instructions_text": "<string>",
    "ai_rules_text": "<string>",
    "ai_enabled": true
  }
]
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Authorizations

X-API-KEY
string
header
required

Response

Successful response

id
string<uuid>
name
string | null
order
integer | null
emoji
string | null
description
string | null
created_at
string
updated_at
string | null
can_be_delete
boolean | null
deleted_at
string | null
is_deleted
boolean
favorite
boolean | null
id_space
string | null
attribute_definitions_order
string[]
ai_instructions
unknown
ai_rules
unknown
ai_instructions_text
string | null
ai_rules_text
string | null
ai_enabled
boolean | null