Search Lists

Search for lists.

GET/v1/lists

Query

Properties

Name	Type	Required	Description
search	string	❌	Search term
size	number	❌	Number of lists to return
page	number	❌	Page number
format	string	❌	Case the size is lower than 10. Output format (text, markdown, json, default (json and markdown))
group_by	string	❌	Case the size is lower than 10. Group data by row or column
fields	string	❌	Fields for the knowledge return (id, title, type, description, content, url, images, video, tutorial and files)

Example

/v1/lists?size=10&page=2&search=first

Response

Properties

Name	Type	Description
id	number	Unique identifier of the list
is_list	boolean	Indicates if the list is a list
title	string	Title of the list
description	string	Description of the list
description_plaintext	string	Description of the list in plain text
visibility	Object	Visibility of the list
visibility.id	number	ID of the visibility
visibility.name	string	Name of the visibility
items	Object[]	Items of the list
items.id	string	ID of the item
items.is_list	boolean	Indicates if the item is a list
items.type	Object	Type of the item
items.type.id	number	ID of the type
items.type.name	string	Name of the type
items.category	Object	Category of the item
items.category.id	number	ID of the category
items.category.name	string	Name of the category
items.topics	null	Topics related to the item
items.title	string	Title of the item
items.body_content	string	Body content of the item
items.body_content_plaintext	string	Body content of the item in plain text
items.body_content_json	null	Body content of the item in JSON format
items.body_content_placeholders	Object	Placeholders for the body content
items.body_content_placeholders.list	null	Placeholders for the body content in list
items.body_content_placeholders.plaintext	string	Placeholders for the body content in plain text
items.description	string	Description of the item
items.description_plaintext	string	Description of the item in plain text
items.visibility	Object	Visibility of the item
item.visibility.id	number	ID of the visibility
item.visibility.name	string	Name of the visibility
item.images	null	Images related to the item
item.cover_images	null	Cover images related to the item
item.avatar_image	string	Avatar image of the item
item.tutorial_steps	null	Tutorial steps related to the item
item.tags	null	Tags related to the item
item.url	string	URL of the item
item.is_premium	boolean	Indicates if the item is premium
item.price	number	Price of the item
item.average_rate	number	Average rate of the item
item.video_url	string	URL of the video
item.created_at	string	Creation date of the item
item.updated_at	null	Update date of the item
item.user	User	User of the item
item.total_upvotes	number	Total upvotes of the item
item.total_uses	number	Total uses of the item
item.total_saves	number	Total saves of the item
item.command	string	Command of the item
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 related to 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
last_saves	null	Last saves of the list
knowledge_base	string	Knowledge base of a list
knowledge_base_json	Object	Knowledge base in JSON format
table_id	string	ID of the table that list belongs to

Example

{
  "response": [
    {
      "id": 15130,
      "is_list": true,
      "title": "Row 1",
      "description": "",
      "description_plaintext": "",
      "visibility": {
        "id": 2,
        "name": "Unlisted"
      },
      "items": [
        {
          "id": "d985c987-8445-48f1-9e54-b4844e081c18",
          "is_list": false,
          "type": {
            "id": 8,
            "name": "Cell"
          },
          "category": {
            "id": 18,
            "name": "Text"
          },
          "topics": null,
          "title": "Best Company",
          "body_content": "<p>Snack Prompt</p>",
          "body_content_plaintext": "Snack Prompt",
          "body_content_json": null,
          "body_content_placeholders": {
            "list": null,
            "plaintext": ""
          },
          "description": "",
          "description_plaintext": "",
          "visibility": {
            "id": 2,
            "name": "Unlisted"
          },
          "images": null,
          "cover_images": null,
          "avatar_image": "",
          "tutorial_steps": null,
          "url": "https://snackprompt.com/cell/best-company",
          "is_premium": false,
          "price": 0,
          "average_rate": 0,
          "video_url": "",
          "created_at": "2025-01-15T22:03:07.220613Z",
          "updated_at": null,
          "user": {
            "id": "Ak2o2WP6xrU8EqSLpmtwO4fEwlC3",
            "name": "Leonardo Sola",
            "username": "sola",
            "avatar": "http://..."
          },
          "total_upvotes": 0,
          "total_uses": 0,
          "total_saves": 0,
          "command": "",
          "knowledge_base": "Title: Best Company\nDescription: \n\nBody: Snack Prompt\n\n"
        },
        {
          "id": "52a8907e-fc22-4cf0-911e-ce30c08cfabd",
          "is_list": false,
          "type": {
            "id": 8,
            "name": "Cell"
          },
          "category": {
            "id": 18,
            "name": "Text"
          },
          "topics": null,
          "title": "Truth",
          "body_content": "<p>YES!</p>",
          "body_content_plaintext": "YES!",
          "body_content_json": null,
          "body_content_placeholders": {
            "list": null,
            "plaintext": ""
          },
          "description": "",
          "description_plaintext": "",
          "visibility": {
            "id": 2,
            "name": "Unlisted"
          },
          "images": null,
          "cover_images": null,
          "avatar_image": "",
          "tutorial_steps": null,
          "tags": null,
          "url": "https://snackprompt.com/cell/truth",
          "is_premium": false,
          "price": 0,
          "average_rate": 0,
          "video_url": "",
          "created_at": "2025-01-15T22:03:07.220613Z",
          "updated_at": null,
          "user": {
            "id": "Ak2o2WP6xrU8EqSLpmtwO4fEwlC3",
            "name": "Leonardo Sola",
            "username": "sola",
            "avatar": "http://..."
          },
          "total_upvotes": 0,
          "total_uses": 0,
          "total_saves": 0,
          "command": "",
          "knowledge_base": "Title: Truth\nDescription: \n\nBody: YES!\n\n"
        },
        {
          "id": "3a146c1a-e1b7-4036-a7ea-f06ee92e0160",
          "is_list": false,
          "type": {
            "id": 8,
            "name": "Cell"
          },
          "category": {
            "id": 18,
            "name": "Text"
          },
          "topics": null,
          "title": "Infinity",
          "body_content": "<p>Too much</p>",
          "body_content_plaintext": "Too much",
          "body_content_json": null,
          "body_content_placeholders": {
            "list": null,
            "plaintext": ""
          },
          "description": "",
          "description_plaintext": "",
          "visibility": {
            "id": 2,
            "name": "Unlisted"
          },
          "images": null,
          "cover_images": null,
          "avatar_image": "",
          "tutorial_steps": null,
          "tags": null,
          "url": "https://snackprompt.com/cell/infinity",
          "is_premium": false,
          "price": 0,
          "average_rate": 0,
          "video_url": "",
          "created_at": "2025-01-15T22:03:07.220613Z",
          "updated_at": null,
          "user": {
            "id": "Ak2o2WP6xrU8EqSLpmtwO4fEwlC3",
            "name": "Leonardo Sola",
            "username": "sola",
            "avatar": "http://..."
          },
          "total_upvotes": 0,
          "total_uses": 0,
          "total_saves": 0,
          "command": "",
          "knowledge_base": "Title: Infinity\nDescription: \n\nBody: Too much\n\n"
        }
      ],
      "total_items": 3,
      "type": {
        "id": 8,
        "name": ""
      },
      "topics": null,
      "cover_images": null,
      "avatar_image": null,
      "video_url": null,
      "tutorial_steps": null,
      "tags": null,
      "url": "https://snackprompt.com/list/67863439-c72e-4fe0-a27c-2822bf47156frow177id",
      "is_premium": false,
      "price": 0,
      "created_at": "2025-01-15T22:03:07.220613Z",
      "updated_at": null,
      "is_saved": false,
      "is_favorite": false,
      "average_rate": 0,
      "rates": null,
      "total_rates": 0,
      "is_voted": false,
      "total_saves": 0,
      "total_upvotes": 0,
      "total_uses": 0,
      "total_sales": 0,
      "user": {
        "id": "Ak2o2WP6xrU8EqSLpmtwO4fEwlC3",
        "name": "Leonardo Sola",
        "username": "sola",
        "avatar": "http://..."
      },
      "last_saves": null,
      "knowledge_base": "Title: Row 1\nDescription: \n\n - Item 1 - Title: Best Company\n - Item 1 - Description: \n - Item 1 - Body: Snack Prompt\n\n - Item 2 - Title: Truth\n - Item 2 - Description: \n - Item 2 - Body: YES!\n\n - Item 3 - Title: Infinity\n - Item 3 - Description: \n - Item 3 - Body: Too much\n\n",
      "knowledge_base_json": {
        "Title": "Row 1",
        "Description": "",
        "Items": [
          {
            "Title": "Best Company",
            "Description": "",
            "Body": "Snack Prompt"
          },
          {
            "Title": "Truth",
            "Description": "",
            "Body": "YES!"
          },
          {
            "Title": "Infinity",
            "Description": "",
            "Body": "Too much"
          }
        ]
      },
      "table_id": "67863439-c72e-4fe0-a27c-2822bf47156f"
    }
  ]
}

CURL Example

curl -X GET "https://api-integrations.snackprompt.com/v1/lists?size=10&page=2&search=first" \
 -H "Content-Type: application/json" \
 -H "x-api-key: YOUR_API_KEY"

Your API Key