Skip to main content
GET
List prompts

Authorizations

Authorization
string
header
required

A Surfais API key — an organisation key or a partner key. Issued by Surfais; shown once. Rotate by creating a new key, then revoking the old one.

Path Parameters

orgId
string<uuid>
required

Organisation id. Org keys: the key's own org. Partner keys: any org with an active link. Anything else is 404.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

limit
integer
default:50

Page size (1–200). Default 50.

Required range: 1 <= x <= 200
cursor
string

Opaque cursor from a previous page's pagination.next_cursor. It pins the walk — its sort anchor, the resolved date window and the FILTERS the first page ran under — so continue with the cursor alone: omitted filters are restored from it. Naming a different value for one of them is 400 invalid_cursor (details.reason = "filter_changed", details.parameter the one that differs); start again from the first page to change a filter.

Maximum string length: 2048
brand_id
string<uuid>

UUID.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
active
enum<string>

true or false.

Available options:
true,
false
tag
string

Prompts carrying this tag. Matched by containment against Prompt.tags EXACTLY AS STORED — case-sensitive (nothing folds a tag on any write path, so Launch and launch are different tags) and not trimmed — so any tag the resource returns filters by it, and storage is bounded to this same envelope. A tag nothing stores returns an empty page, not an error.

Required string length: 1 - 256
Pattern: ^[^\u0000-\u001f\u007f-\u009f]+$
country
string

Prompts whose countries include this market. Case-insensitive: the value is trimmed and upper-cased to match storage. Accepts any token Prompt.countries can return — an ISO 3166-1 alpha-2 code, the OTHER geography sentinel, or a legacy token — so a value the resource hands you always filters by it. A token nothing stores returns an empty page, not an error.

Required string length: 1 - 256
Pattern: ^[^\u0000-\u001f\u007f-\u009f]+$

Response

Prompts.

data
object[]
required
pagination
object
required