Get List Items

The items are returned ordered by their index. You can reorder the items in a list as needed. By default, the order index is assigned incrementally.

GET/v1/list/{id}/items

Param

Properties

Name	Type	Required	Description
id	text	✅	ID of the list.
size	number	❌	Size of item will returned, default value is 4.
page	number	❌	Page, used for pagination, default value is 1.
order_by	string	❌	Order by, used for ordering the items, default value is 'created_at'. Can be 'created_at', 'updated_at' or 'title'
order_dir	string	❌	Order direction, used for ordering the items, default value is 'desc'. Can be 'asc' or 'desc'

Example

/v1/list/2ESKXnnCy/items

Response

Properties

Name	Type	Description
id	string	ID of the item
is_list	boolean	Indicates if the item is a list
type	Object	Type of the item
type.id	number	ID of the type
type.name	string	Name of the type
category	Object	Category of the item
category.id	number	ID of the category
category.name	string	Name of the category
topics	null	Topics related to the item
title	string	Title of the item
body_content	string	Body content of the item
body_content_plaintext	string	Body content of the item in plain text
body_content_json	null	Body content of the item in JSON format
body_content_placeholders	Object	Placeholders for the body content
body_content_placeholders.list	null	Placeholders for the body content in list
body_content_placeholders.plaintext	string	Placeholders for the body content in plain text
description	string	Description of the item
description_plaintext	string	Description of the item in plain text
visibility	Object	Visibility of the item
visibility.id	number	ID of the visibility
visibility.name	string	Name of the visibility
images	null	Images related to the item
cover_images	null	Cover images related to the item
avatar_image	string	Avatar image of the item
tutorial_steps	null	Tutorial steps related to the item
tags	null	Tags related to the item
url	string	URL of the item
is_premium	boolean	Indicates if the item is premium
price	number	Price of the item
average_rate	number	Average rate of the item
video_url	string	URL of the video
created_at	string	Creation date of the item
updated_at	null	Update date of the item
user	User	User of the item
total_upvotes	number	Total upvotes of the item
total_uses	number	Total uses of the item
total_saves	number	Total saves of the item
command	string	Command of the item
knowledge_base	string	Knowledge base of the item
total_items	number	Total items of the list
type	Object	Type of the list
type.id	number	ID of the type
type.name	string	Name of the type
topics	null	Topics related to the list
cover_images	null	Cover images of the list
avatar_image	null	Avatar image of the list
video_url	null	URL of the video
tutorial_steps	null	Tutorial steps of the list
tags	null	Tags of the list
url	string	URL of the list
is_premium	boolean	Indicates if the list is premium
price	number	Price of the list
created_at	string	Creation date of the list
updated_at	null	Update date of the list
is_saved	boolean	Indicates if the list is saved
is_favorite	boolean	Indicates if the list is favorite
average_rate	number	Average rate of the list
rates	null	Rates of the list
total_rates	number	Total rates of the list
is_voted	boolean	Indicates if the list is voted
total_saves	number	Total saves of the list
total_upvotes	number	Total upvotes of the list
total_uses	number	Total uses of the list
total_sales	number	Total sales of the list
user	User	User of the list

Example

{
  "response": [
    {
      "id": "HxXTSTCAA",
      "is_list": false,
      "type": {
        "id": 11,
        "name": "Image"
      },
      "category": {
        "id": 20,
        "name": "Default"
      },
      "topics": null,
      "title": "Visual Prompt 4:53:28 PM",
      "body_content": "",
      "body_content_plaintext": "",
      "body_content_json": null,
      "body_content_placeholders": {
        "list": null,
        "plaintext": ""
      },
      "description": "<p>Saved image from Snack Prompt</p>",
      "description_plaintext": "Saved image from Snack Prompt",
      "visibility": {
        "id": 1,
        "name": "Public"
      },
      "images": [
        {
          "id": 5387,
          "url": "http://files.snackprompt.com.s3-website.us-east-2.amazonaws.com/HxXTSTCAA-output-image-8VS4.jpg"
        }
      ],
      "cover_images": null,
      "avatar_image": "",
      "tutorial_steps": null,
      "url": "https://snackprompt.com/image/visual-prompt-45328-pm",
      "is_premium": false,
      "price": 0,
      "average_rate": 0,
      "video_url": "",
      "created_at": "2025-04-28T19:53:29.047307Z",
      "updated_at": null,
      "user": {
        "id": "HhWKhVIPM7er5KttMNC68hl5o8t1",
        "name": "Guilherme Esteves",
        "username": "gui_esteves",
        "avatar": "http://files.snackprompt.com.s3-website.us-east-2.amazonaws.com/HhWKhVIPM7er5KttMNC68hl5o8t1-1731005000.png"
      },
      "total_upvotes": 0,
      "total_uses": 0,
      "total_saves": 1,
      "command": ""
    },
    {
      "id": "KtkIhpuTN",
      "is_list": false,
      "type": {
        "id": 11,
        "name": "Image"
      },
      "category": {
        "id": 20,
        "name": "Default"
      },
      "topics": null,
      "title": "Visual Prompt 4:53:29 PM",
      "body_content": "",
      "body_content_plaintext": "",
      "body_content_json": null,
      "body_content_placeholders": {
        "list": null,
        "plaintext": ""
      },
      "description": "<p>Saved image from Snack Prompt</p>",
      "description_plaintext": "Saved image from Snack Prompt",
      "visibility": {
        "id": 1,
        "name": "Public"
      },
      "images": [
        {
          "id": 5388,
          "url": "http://files.snackprompt.com.s3-website.us-east-2.amazonaws.com/KtkIhpuTN-output-image-y0ir.jpg"
        }
      ],
      "cover_images": null,
      "avatar_image": "",
      "tutorial_steps": null,
      "url": "https://snackprompt.com/image/visual-prompt-45329-pm",
      "is_premium": false,
      "price": 0,
      "average_rate": 0,
      "video_url": "",
      "created_at": "2025-04-28T19:53:29.546565Z",
      "updated_at": null,
      "user": {
        "id": "HhWKhVIPM7er5KttMNC68hl5o8t1",
        "name": "Guilherme Esteves",
        "username": "gui_esteves",
        "avatar": "http://files.snackprompt.com.s3-website.us-east-2.amazonaws.com/HhWKhVIPM7er5KttMNC68hl5o8t1-1731005000.png"
      },
      "total_upvotes": 0,
      "total_uses": 0,
      "total_saves": 1,
      "command": ""
    }
  ]
}

CURL Example

curl -X GET "https://api-integrations.snackprompt.com/v1/list/{id}/items" \
 -H "Content-Type: application/json" \
 -H "x-api-key: YOUR_API_KEY"

Your API Key