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>'
[
  {
    "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
  }
]

Documentation Index

Fetch the complete documentation index at: https://developer.breakcold.com/llms.txt

Use this file to discover all available pages before exploring further.

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