v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-013593344.3 KB
Prompts

List Prompts

Browse through all your prompts to see what you're using across your AI applications. Returns all prompts by default (both active and inactive versions), or filter by product or version to narrow down the results.

Filtering & Pagination:

  • Filter by productId to see prompts for a specific product
  • Filter by versionId to see a specific version
  • Choose your pagination style: cursor-based (limit + cursor) or page-based (page + pageSize)
  • Check the Link header for easy pagination navigation

Note: This returns lightweight data with just component IDs. Use GET /prompts/:id to fetch the full prompt content.

get/prompts

Query parameters

limitnumber

Page size limit (cursor-based pagination). Use either limit/cursor OR page/pageSize, not both.

Page size limit (cursor-based pagination). Use either limit/cursor OR page/pageSize, not both.

pagenumber

Page number (page-based pagination). Use either page/pageSize OR limit/cursor, not both.

Page number (page-based pagination). Use either page/pageSize OR limit/cursor, not both.

pageSizenumber

Number of items per page (page-based pagination). Use either page/pageSize OR limit/cursor, not both.

Number of items per page (page-based pagination). Use either page/pageSize OR limit/cursor, not both.

includeArchivedboolean

Include archived prompts.

Include archived prompts.

versionIdstring uuid

Filter prompts by specific version ID.

Filter prompts by specific version ID.

productIdstring uuid

Filter prompts by product ID.

Filter prompts by product ID.

activeOnlyboolean

Filter to only show prompts that are part of active versions. When true, only returns prompts associated with versions where isActive=true.

Filter to only show prompts that are part of active versions. When true, only returns prompts associated with versions where isActive=true.

Response

Prompts retrieved successfully. Check the Link header for pagination URLs (first, prev, next).

idstring uuid required

The Greenflash prompt ID.

externalPromptIdstring nullable required

Your external identifier for the prompt.

namestring nullable required

Prompt name.

versionIdstring uuid nullable required

The version ID this prompt is associated with, or null if the prompt is not part of any version.

productIdstring uuid nullable required

The product ID this prompt is associated with.

archivedAtstring nullable required

ISO 8601 timestamp when archived, or null if active.

createdAtstring required

ISO 8601 timestamp when created.

updatedAtstring required

ISO 8601 timestamp when last updated.