Skip to main content
GET
/
api
/
v1
/
site
/
pages
List site pages
curl --request GET \
  --url https://app.promptingco.com/api/v1/site/pages \
  --header 'x-api-key: <api-key>'
{
  "ok": true,
  "data": {
    "scope": {
      "product": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>"
      },
      "organization": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>"
      }
    },
    "page": 123,
    "pageSize": 123,
    "query": "<string>",
    "status": "<string>",
    "type": "<string>",
    "isManual": true,
    "pathPrefix": "<string>",
    "hasContent": true,
    "domainId": "<string>",
    "domain": "<string>",
    "orderBy": "createdAt",
    "orderByDirection": "asc",
    "total": 1,
    "totalPages": 1,
    "items": [
      {
        "id": "<string>",
        "title": "<string>",
        "filePath": "<string>",
        "sourceUrl": "<string>",
        "status": "<string>",
        "type": "<string>",
        "isManual": true,
        "metaTitle": "<string>",
        "metaDescription": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "domains": [
          {
            "id": "<string>",
            "domain": "<string>",
            "isCanonical": true
          }
        ]
      }
    ]
  }
}

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)
  • products:read: Read product metadata and competitor data
  • products:write: Update product settings and competitor lists

Query Parameters

productId
string
required
Minimum string length: 1
page
integer
pageSize
integer
orderBy
enum<string>
Available options:
createdAt,
updatedAt
orderByDirection
enum<string>
Available options:
asc,
desc
query
string
q
string
status
enum<string>
Available options:
draft,
published
type
string
isManual
boolean
pathPrefix
string
hasContent
boolean
domainId
string
domain
string

Response

Successful response

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