PromptsList prompts

List prompts

Returns the workspace's tracked prompts, one page at a time.

Required scope: v2:prompts.

  • visibility and lastRunAt are null until the prompt has results.
  • tags is an empty array when the prompt has no tags.
curl -X GET "https://api.opttab.com/v1/external/prompts?page=1&pageSize=20" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "items": [
    {
      "id": "33333333-3333-4333-8333-333333333333",
      "text": "What is the best running shoe for daily training?",
      "topicId": "22222222-2222-4222-8222-222222222222",
      "topicName": "Running shoes",
      "isActive": true,
      "cadence": "daily",
      "visibility": 42,
      "country": "US",
      "language": "en",
      "targetPlatforms": [
        "chatgpt",
        "perplexity"
      ],
      "tags": [
        {
          "name": "Running",
          "subTags": [
            "Daily"
          ]
        }
      ],
      "lastRunAt": "2026-10-18T12:00:00.000Z"
    }
  ],
  "page": 1,
  "pageSize": 20,
  "totalCount": 1
}
GET
/v1/external/prompts
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An API key secret from Settings › API. It starts with opt_live_. Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key header and an ?api_key= query parameter do not authenticate.

An API key secret from Settings › API. It starts with opt_live_. Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key header and an ?api_key= query parameter do not authenticate.
query
pageinteger

The page to return, starting at 1.

Min: 1
query
pageSizeinteger

Items per page. Maximum 100.

Min: 1 • Max: 100
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An API key secret from Settings › API. It starts with opt_live_. Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key header and an ?api_key= query parameter do not authenticate.

Query Parameters

pageinteger

The page to return, starting at 1.

Example:
1
pageSizeinteger

Items per page. Maximum 100.

Example:
20

Responses

itemsarray
Required
pageinteger
Required

The page returned.

pageSizeinteger
Required

Items per page.

totalCountinteger
Required

Total items across all pages.