Skip to main content
GET
List prompts

Authorizations

Authorization
string
header
required

Send your workspace API key as Authorization: Bearer zr_live_….

Query Parameters

page
integer
default:1

Which page to return. Defaults to 1.

Required range: x >= 1
limit
integer
default:20

How many items per page (1–100). Defaults to 20.

Required range: 1 <= x <= 100
status
enum<string>

Only return prompts with this status. Where a prompt is in its life: draft, active, paused, suggested (AI-proposed), or rejected.

Available options:
draft,
active,
paused,
suggested,
rejected
topicId
integer

Only return prompts in this topic.

Only return prompts whose text contains this word or phrase.

Response

A page of prompts.

success
boolean
Example:

true

data
object
message
string
Example:

"Prompts retrieved successfully"