Skip to main content
GET
List content

Authorizations

x-api-key
string
header
required

Organization-scoped API key. Available scopes:

  • content:read: Read site pages, markdown content, and llms.txt files
  • content:write: Create, update, and delete site pages and content
  • prompts:read: Read prompts, topics, and prompt analysis results
  • prompts:write: Create, update, archive prompts
  • simulations:read: Read agent-simulation tasks, runs, environments, and analytics
  • simulations:write: Create and trigger simulation runs
  • logs:read: Read AI-traffic logs and request-level audit events
  • analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
  • analytics:write: Write events to analytics
  • products:read: Read product metadata and competitor data
  • products:write: Update product settings and competitor lists

Query Parameters

productId
string

Product ID. Provide exactly one of productId or productSlug (the server enforces this at runtime).

Minimum string length: 1
productSlug
string

Product slug. Provide exactly one of productId or productSlug (the server enforces this at runtime).

Minimum string length: 1
status
enum<string>

Lifecycle filter. published (default) and draft list live site pages; pending_review, generating, failed, rejected, and approved list content drafts in the review queue.

Available options:
draft,
published,
pending_review,
generating,
failed,
rejected,
approved
promptId
string

Draft statuses only: filter drafts generated for a prompt.

Minimum string length: 1
page
integer
pageSize
integer
orderBy
enum<string>
Available options:
createdAt,
updatedAt,
deletedAt
orderByDirection
enum<string>
Available options:
asc,
desc
query
string
q
string
type
string
isManual
boolean
pathPrefix
string
hasContent
boolean
domainId
string
domain
string
archivedStatus
enum<string>
Available options:
active,
archived,
all

Response

Successful response

ok
enum<boolean>
required
Available options:
true
data
object
required