Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Manage Lists

Organize content with lists and folders

Lists

Lists are collections that organize elementals. Use them to group related prompts, snippets, or documents together.

Get List by ID

get

Retrieves a specific list with optional expanded items.

Authorizations
x-api-keystringRequired

API Key authentication. Get your key at snackprompt.com/api-keys.

Example: x-api-key: sk-your-api-key-here

Path parameters
list_idstringRequired
Query parameters
formatstring · enumOptionalPossible values:
expand_itemsbooleanOptional

Include full elemental details

Responses
200

List details

application/json
codeintegerOptional

HTTP status code

Example: 200
get/v1/list/{list_id}
cURL
curl -X GET "https://api-integrations.snackprompt.com/v1/list/list123?expand_items=true" \
  -H "x-api-key: YOUR_API_KEY"

{
  "code": 200,
  "meta": {
    "version": "v1.0.2",
    "is_authenticaded": true,
    "limit": 1,
    "offset": 1,
    "total": 1
  },
  "response": {
    "id": "text",
    "title": "text",
    "description": "text",
    "description_plaintext": "text",
    "visibility": {
      "id": 1,
      "name": "text"
    },
    "type": {
      "id": 1,
      "name": "text"
    },
    "topics": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "items": [
      {
        "id": "text",
        "is_list": true,
        "type": {
          "id": 1,
          "name": "text"
        },
        "category": {
          "id": 1,
          "name": "text"
        },
        "topics": [
          {
            "id": 1,
            "name": "text"
          }
        ],
        "title": "text",
        "body_content": "text",
        "body_content_html": "text",
        "body_content_plaintext": "text",
        "body_content_json": {},
        "body_content_placeholders": {
          "list": [
            "text"
          ],
          "plaintext": "text"
        },
        "description": "text",
        "description_plaintext": "text",
        "visibility": {
          "id": 1,
          "name": "text"
        },
        "images": [
          {
            "id": 1,
            "url": "text",
            "width": 1,
            "height": 1,
            "blur": "text"
          }
        ],
        "cover_images": [
          {
            "id": 1,
            "url": "text",
            "width": 1,
            "height": 1,
            "blur": "text"
          }
        ],
        "avatar_image": "text",
        "files": [
          {
            "id": 1,
            "name": "text",
            "size": 1,
            "created_at": "2026-01-01T00:00:00.000Z",
            "url": "text",
            "data": [
              1
            ]
          }
        ],
        "tutorial_steps": [
          {
            "id": 1,
            "title": "text",
            "description": "text",
            "video_url": "text"
          }
        ],
        "url": "text",
        "is_premium": true,
        "price": 1,
        "average_rate": 1,
        "video_url": "text",
        "created_at": "2026-01-01T00:00:00.000Z",
        "updated_at": "2026-01-01T00:00:00.000Z",
        "user": {
          "id": "text",
          "name": "text",
          "username": "text",
          "email": "text",
          "avatar": "text"
        },
        "comments": [
          {
            "id": 1,
            "message": "text",
            "created_at": "2026-01-01T00:00:00.000Z",
            "updated_at": "2026-01-01T00:00:00.000Z",
            "total_votes": 1,
            "user": {
              "id": "text",
              "name": "text",
              "username": "text",
              "email": "text",
              "avatar": "text"
            },
            "replies": [
              {
                "id": 1,
                "message": "text",
                "parent_id": 1,
                "created_at": "2026-01-01T00:00:00.000Z",
                "updated_at": "2026-01-01T00:00:00.000Z",
                "total_votes": 1,
                "user": {
                  "id": "text",
                  "name": "text",
                  "username": "text",
                  "email": "text",
                  "avatar": "text"
                }
              }
            ]
          }
        ],
        "total_comments": 1,
        "rates": [
          {
            "id": 1,
            "message": "text",
            "rating": 1,
            "created_at": "2026-01-01T00:00:00.000Z",
            "updated_at": "2026-01-01T00:00:00.000Z",
            "total_votes": 1,
            "user": {
              "id": "text",
              "name": "text",
              "username": "text",
              "email": "text",
              "avatar": "text"
            }
          }
        ],
        "total_rates": 1,
        "total_sales": 1,
        "total_upvotes": 1,
        "total_uses": 1,
        "total_saves": 1,
        "command": "text",
        "columns": [
          "[Circular Reference]"
        ],
        "rows": [
          "[Circular Reference]"
        ],
        "tags": [
          {
            "id": "scZahUfID",
            "title": "text",
            "color": "text",
            "description": "text",
            "user_id": "text",
            "created_at": "2026-01-01T00:00:00.000Z",
            "updated_at": "2026-01-01T00:00:00.000Z"
          }
        ],
        "knowledge_base": {},
        "knowledge_base_json": {},
        "settings": {
          "is_knowledge_base": true,
          "is_template": true,
          "is_system": true
        }
      }
    ],
    "total_items": 1,
    "cover_images": [
      {
        "id": 1,
        "url": "text",
        "width": 1,
        "height": 1,
        "blur": "text"
      }
    ],
    "images": [
      {
        "id": 1,
        "url": "text",
        "width": 1,
        "height": 1,
        "blur": "text"
      }
    ],
    "files": [
      {
        "id": 1,
        "name": "text",
        "size": 1,
        "created_at": "2026-01-01T00:00:00.000Z",
        "url": "text",
        "data": [
          1
        ]
      }
    ],
    "avatar_image": "text",
    "video_url": "text",
    "tutorial_steps": [
      {
        "id": 1,
        "title": "text",
        "description": "text",
        "video_url": "text"
      }
    ],
    "url": "text",
    "is_premium": true,
    "price": 1,
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z",
    "is_saved": true,
    "is_favorite": true,
    "is_voted": true,
    "average_rate": 1,
    "rates": [
      {
        "id": 1,
        "message": "text",
        "rating": 1,
        "created_at": "2026-01-01T00:00:00.000Z",
        "updated_at": "2026-01-01T00:00:00.000Z",
        "total_votes": 1,
        "user": {
          "id": "text",
          "name": "text",
          "username": "text",
          "email": "text",
          "avatar": "text"
        }
      }
    ],
    "total_rates": 1,
    "total_saves": 1,
    "total_upvotes": 1,
    "total_uses": 1,
    "total_sales": 1,
    "user": {
      "id": "text",
      "name": "text",
      "username": "text",
      "email": "text",
      "avatar": "text"
    },
    "last_saves": [
      {
        "id": "text",
        "name": "text",
        "username": "text",
        "email": "text",
        "avatar": "text"
      }
    ],
    "table_id": "text",
    "table_orientation": "text",
    "tags": [
      {
        "id": "scZahUfID",
        "title": "text",
        "color": "text",
        "description": "text",
        "user_id": "text",
        "created_at": "2026-01-01T00:00:00.000Z",
        "updated_at": "2026-01-01T00:00:00.000Z"
      }
    ],
    "knowledge_base": {},
    "knowledge_base_json": {},
    "settings": {
      "is_knowledge_base": true,
      "is_template": true,
      "is_system": true
    }
  }
}

Get List Items

get

Retrieves paginated items from a list.

Authorizations
x-api-keystringRequired

API Key authentication. Get your key at snackprompt.com/api-keys.

Example: x-api-key: sk-your-api-key-here

Path parameters
list_idstringRequired
Query parameters
pageintegerOptionalDefault: 1
sizeinteger · max: 100OptionalDefault: 4
Responses
200

List items

application/json
codeintegerOptionalExample: 200
get/v1/list/{list_id}/items
cURL
curl -X GET "https://api-integrations.snackprompt.com/v1/list/list123/items?page=1&size=10" \
  -H "x-api-key: YOUR_API_KEY"
200

List items

{
  "code": 200,
  "meta": {
    "version": "v1.0.2",
    "is_authenticaded": true,
    "limit": 1,
    "offset": 1,
    "total": 1,
    "size": 1,
    "page": 1
  },
  "response": []
}

Search Lists

get

Search for lists across the platform.

Authorizations
x-api-keystringRequired

API Key authentication. Get your key at snackprompt.com/api-keys.

Example: x-api-key: sk-your-api-key-here

Query parameters
searchstringOptional
sizeintegerOptionalDefault: 4
pageintegerOptionalDefault: 1
Responses
200

Search results

No content
get/v1/lists
cURL
curl -X GET "https://api-integrations.snackprompt.com/v1/lists?search=marketing" \
  -H "x-api-key: YOUR_API_KEY"
200

Search results

No content

Get User Lists

get

Retrieves all lists belonging to the authenticated user.

Authorizations
x-api-keystringRequired

API Key authentication. Get your key at snackprompt.com/api-keys.

Example: x-api-key: sk-your-api-key-here

Responses
200

User's lists

No content
get/v1/user/lists
cURL
curl -X GET "https://api-integrations.snackprompt.com/v1/user/lists" \
  -H "x-api-key: YOUR_API_KEY"
200

User's lists

No content

Create List

post

Creates a new list for organizing elementals.

Authorizations
x-api-keystringRequired

API Key authentication. Get your key at snackprompt.com/api-keys.

Example: x-api-key: sk-your-api-key-here

Body
idstringOptional
titlestringRequired
descriptionstringOptional
templatestringOptional
template_overwritebooleanOptional
content_typeintegerOptional
visibilityintegerOptionalDefault: 1
modestringOptional
is_premiumbooleanOptional
is_fixed_pricebooleanOptional
priceintegerOptional
price_originalintegerOptional
video_urlstringOptional
Responses
201

List created

No content
post/v1/user/list
cURL
curl -X POST "https://api-integrations.snackprompt.com/v1/user/list" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "Marketing Prompts", "description": "Collection for marketing", "visibility": 1}'

No content

Update List

put

Updates an existing list.

Authorizations
x-api-keystringRequired

API Key authentication. Get your key at snackprompt.com/api-keys.

Example: x-api-key: sk-your-api-key-here

Path parameters
list_idstringRequired
Body
idstringOptional
titlestringRequired
descriptionstringOptional
templatestringOptional
template_overwritebooleanOptional
content_typeintegerOptional
visibilityintegerOptionalDefault: 1
modestringOptional
is_premiumbooleanOptional
is_fixed_pricebooleanOptional
priceintegerOptional
price_originalintegerOptional
video_urlstringOptional
Responses
200

List updated

No content
put/v1/user/list/{list_id}
cURL
curl -X PUT "https://api-integrations.snackprompt.com/v1/user/list/list123" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "Updated Name"}'

No content

Remove Elementals from List

delete

Removes specified elementals from a list.

Authorizations
x-api-keystringRequired

API Key authentication. Get your key at snackprompt.com/api-keys.

Example: x-api-key: sk-your-api-key-here

Path parameters
list_idstringRequired
Body
Responses
204

Elementals removed from list

No content
delete/v1/user/list/{list_id}/elementals
cURL
curl -X DELETE "https://api-integrations.snackprompt.com/v1/user/list/list123/elementals" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"item_ids": [{"elemental_id": "abc123"}]}'
204

Elementals removed from list

No content
PreviousTypes & Categories
NextManage Tags

Last updated

Was this helpful?