List prompts | Respan Docs

curl -X POST "https://api.respan.ai/api/prompts/list/?page=1&page_size=25&sort_by=-current_version__updated_at" \
     -H "Authorization: Bearer <respanApiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "filters": {
    "name": {
      "value": [
        "support"
      ],
      "operator": "icontains"
    },
    "starred": {
      "value": [
        true
      ],
      "operator": ""
    }
  }
}'

{
  "count": 42,
  "next": "https://api.respan.ai/api/prompts/list/?page=2",
  "previous": null,
  "results": [
    {
      "id": "prompt_abc123",
      "name": "Customer Support Assistant",
      "description": "Handles customer support queries with empathy",
      "prompt_slug": "customer-support-assistant",
      "tags": [
        {
          "id": "tag_abc123",
          "name": "support",
          "color": "#3B82F6",
          "created_at": "2026-01-01T00:00:00Z",
          "updated_at": "2026-01-01T00:00:00Z"
        }
      ],
      "current_version": {
        "version": 3,
        "model": "gpt-4o",
        "updated_at": "2026-01-20T10:30:00Z"
      },
      "live_version": {
        "version": 2,
        "model": "gpt-4o-mini",
        "updated_at": "2026-01-15T08:00:00Z"
      },
      "created_at": "2026-01-01T00:00:00Z",
      "updated_at": "2026-01-20T10:30:00Z"
    }
  ]
}

Authentication

AuthorizationBearer

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

AuthorizationBearer

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

Query parameters

pageintegerOptionalDefaults to 1

Page number.

page_sizeintegerOptional<=100Defaults to 25

Number of prompts per page. Maximum is 100.

sort_byenumOptionalDefaults to -id

Sort field. Prefix with - for descending. Common values are -id and -current_version__updated_at.

Allowed values:

Request

This endpoint expects an object.

filtersobjectOptional

Each key is a field to filter on, and each value is a condition: {"<field>": {"operator": "<operator>", "value": [...]}}. A prompt must match every condition. To set two conditions on one field, such as a range, pass a list of conditions.

Operators: "" (equals, the default), not, in, not_in, lt, lte, gt, gte, contains, not_contains, icontains (ignores case), startswith, not_startswith, endswith, not_endswith, empty, not_empty. Put values in a list: "" and in match any of the listed values, and not and not_in match none of them. Other operators take one value; for empty and not_empty, send [""].

Fields: prompt_id, prompt_slug, name, description, starred, commit_count, creator_email, version fields through current_version__<field> or live_version__<field> (for example current_version__model or current_version__updated_at), tags (prompts with any of the given tag IDs), and is_deleted (send "value": true to get deleted prompts instead of active ones). Unsupported fields return a 400 error.

Example:

{
  "name": {"operator": "icontains", "value": ["support"]},
  "current_version__model": {"operator": "in", "value": ["gpt-5.5", "claude-sonnet-4-5-20250929"]}
}

Response

Paginated list of prompts.

countintegerOptional

Number of results on this page, not the total. Request pages until next is null to get every result.

nextstring or nullOptional

Next page URL.

previousstring or nullOptional

Previous page URL.

resultslist of objectsOptional

Errors

403

Forbidden Error