PageWeave Submissions API
Stored form submissions, including submitter data.
Stored form submissions, including submitter data.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/pageweave-dev:pageweave-dev-submissions-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: PageWeave Submissions API
version: 1.0.0
summary: Programmatic control plane for PageWeave websites.
description: 'Version 1 of the PageWeave HTTP API. Every endpoint under `/api/v1`
authenticates with a bearer API key unless its operation declares an
anonymous alternative — `security: []` or an optional requirement such as
`[{bearerAuth: []}, {}]` for upload sessions.
Errors use RFC 9457 Problem Details (`application/problem+json`). Rate
limits follow draft-ietf-httpapi-ratelimit-headers-11 and are reported on
every authenticated response through the `RateLimit-Policy` and
`RateLimit` headers.
The contract is additive within v1: operations and response fields may be
added, never removed or changed incompatibly.'
contact:
name: PageWeave
url: https://pageweave.dev/docs/api
externalDocs:
description: Guide, authentication, pagination, errors, and worked examples.
url: https://pageweave.dev/docs/api/guide
servers:
- url: https://pageweave.dev
description: Production
tags:
- name: Submissions
description: Stored form submissions, including submitter data.
paths:
/api/v1/websites/{website_id}/forms/{form_id}/submissions:
parameters:
- name: website_id
in: path
required: true
description: Website UUID or subdomain.
schema:
type: string
- name: form_id
in: path
required: true
description: Form UUID.
schema:
type: string
format: uuid
get:
operationId: listFormSubmissions
summary: List form submissions
description: 'Keyset-paginated submissions. Rows carry the stored field payload
(`data`); file uploads are returned only by `getSubmission`. Responses
are `Cache-Control: no-store`.'
tags:
- Submissions
security:
- bearerAuth: []
x-required-permission: submission.read
x-required-scope: website
x-required-credential: read
parameters:
- $ref: '#/components/parameters/Cursor'
- $ref: '#/components/parameters/Limit'
- name: spam_verdict
in: query
required: false
description: Exact spam verdict filter.
schema:
type: string
enum:
- ham
- quarantined
- discarded
- incomplete
- name: read
in: query
required: false
description: Exact read-state filter.
schema:
type: boolean
responses:
'200':
description: A page of submissions
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionsCollection'
example:
data:
- id: 019fc8b2-5c3d-7d4e-9a62-1b0c2d3e4f5a
form_id: 019fc8a1-4b2d-7c3e-8f51-0a9b8c7d6e5f
form_version_id: 019fc8a1-5d4e-7e6f-8a73-2c1d3e4f5a6b
read: false
spam_verdict: ham
spam_score: 0
spam_overridden: false
email_verification_status: not_required
data:
email: ada@example.com
message: Hello — I would like a quote.
page_url: https://ada.example.com/contact
created_at: '2026-11-02T10:41:02Z'
updated_at: '2026-11-02T10:41:02Z'
pagination:
limit: 25
has_more: false
next_cursor: null
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
/api/v1/websites/{website_id}/forms/{form_id}/submissions/{id}:
parameters:
- name: website_id
in: path
required: true
description: Website UUID or subdomain.
schema:
type: string
- name: form_id
in: path
required: true
description: Form UUID.
schema:
type: string
format: uuid
- name: id
in: path
required: true
description: Submission UUID.
schema:
type: string
format: uuid
get:
operationId: getSubmission
summary: Get a submission
description: 'The submission with uploads and one delivery row per form recipient.
Responses are `Cache-Control: no-store`; submitter data is personal
data, and delivery addresses are masked without
`form.recipient.manage`.'
tags:
- Submissions
security:
- bearerAuth: []
x-required-permission: submission.read
x-required-scope: website
x-required-credential: read
parameters:
- $ref: '#/components/parameters/IfNoneMatch'
responses:
'200':
description: The submission with uploads
headers:
ETag:
$ref: '#/components/headers/ETag'
Last-Modified:
$ref: '#/components/headers/LastModified'
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionDetail'
'304':
$ref: '#/components/responses/NotModified'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/TooManyRequests'
patch:
operationId: updateSubmission
summary: Update a submission
description: 'Marks the submission read/unread or changes the owner spam verdict.
Releasing a non-ham submission re-enters the notification path;
`ham` on an already-ham row is a no-op. Only `ham` and `quarantined`
are accepted as owner verdicts.'
tags:
- Submissions
security:
- bearerAuth: []
x-required-permission: submission.update
x-required-scope: website
x-required-credential: write
parameters:
- $ref: '#/components/parameters/IfMatch'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionUpdateRequest'
responses:
'200':
description: The updated submission
headers:
ETag:
$ref: '#/components/headers/ETag'
Last-Modified:
$ref: '#/components/headers/LastModified'
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionDetail'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'412':
$ref: '#/components/responses/PreconditionFailed'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'422':
$ref: '#/components/responses/Unprocessable'
'429':
$ref: '#/components/responses/TooManyRequests'
delete:
operationId: deleteSubmission
summary: Delete a submission
description: 'Permanently deletes the submission and its uploads. The deletion audit
row carries form/version/verdict metadata only, never submitter data.'
tags:
- Submissions
security:
- bearerAuth: []
x-required-permission: submission.delete
x-required-scope: website
x-required-credential: write
parameters:
- $ref: '#/components/parameters/IfMatch'
responses:
'204':
$ref: '#/components/responses/NoContent'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'412':
$ref: '#/components/responses/PreconditionFailed'
'429':
$ref: '#/components/responses/TooManyRequests'
components:
headers:
RetryAfter:
description: Seconds to wait before retrying.
schema:
type: integer
ETag:
description: Strong validator for the current representation.
schema:
type: string
LastModified:
description: Last modification time (HTTP-date).
schema:
type: string
WWWAuthenticate:
description: 'Bearer challenge (RFC 9110 §11.6.1, RFC 6750 §3).
Carries `error="invalid_token"` when a credential was presented but
could not be resolved. `/api/v1` uses the `api` realm; OAuth
protected-resource metadata (RFC 9728) is advertised by MCP only.
'
schema:
type: string
example: Bearer realm="api", error="invalid_token"
RateLimitPolicy:
description: 'The applicable quota policy (draft-ietf-httpapi-ratelimit-headers-11).
'
schema:
type: string
example: '"write";q=120;w=60'
RateLimit:
description: 'The remaining quota and seconds until the window resets
(draft-ietf-httpapi-ratelimit-headers-11).
'
schema:
type: string
example: '"write";r=119;t=42'
responses:
UnsupportedMediaType:
description: Request bodies must use application/json
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
TooManyRequests:
description: A rate limit was exceeded
headers:
Retry-After:
$ref: '#/components/headers/RetryAfter'
RateLimit-Policy:
$ref: '#/components/headers/RateLimitPolicy'
RateLimit:
$ref: '#/components/headers/RateLimit'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
Unauthorized:
description: Missing, invalid, expired, or revoked credential
headers:
WWW-Authenticate:
$ref: '#/components/headers/WWWAuthenticate'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
Unprocessable:
description: The payload could not be processed
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
BadRequest:
description: The request is malformed or carries unknown query parameters
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
Forbidden:
description: The session, credential, or role does not permit the action
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
NotFound:
description: The resource does not exist or is not visible to this caller
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
NoContent:
description: The action succeeded and has no body
PreconditionFailed:
description: If-Match did not match the current representation
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
NotModified:
description: The representation has not changed
headers:
ETag:
$ref: '#/components/headers/ETag'
parameters:
IfMatch:
name: If-Match
in: header
required: false
description: 'Strong validator for optimistic concurrency. A stale value fails with
412 (RFC 9110 §13.1.1).
'
schema:
type: string
Limit:
name: limit
in: query
required: false
description: Page size (1-100, default 25).
schema:
type: integer
minimum: 1
maximum: 100
default: 25
Cursor:
name: cursor
in: query
required: false
description: Opaque keyset cursor from the previous page's `pagination.next_cursor`.
schema:
type: string
IfNoneMatch:
name: If-None-Match
in: header
required: false
description: 'Revalidate a cached representation; a matching value answers 304
without a body (RFC 9110 §13.1.2).
'
schema:
type: string
schemas:
SubmissionUpload:
type: object
additionalProperties: false
required:
- field_name
- filename
- content_type
- byte_size
- download_url
properties:
field_name:
type: string
filename:
type: string
content_type:
type: string
byte_size:
type: integer
minimum: 0
download_url:
type: string
format: uri
Problem:
type: object
example:
type: https://pageweave.dev/errors/forbidden
title: Forbidden
status: 403
detail: The API key lacks the page.create permission for this website.
instance: /api/v1/websites/019f9c2a-6a1b-7a3d-8f2e-4b6c8d0e1f23/pages
request_id: 019fc8e5-8f6a-9b7c-8d85-4f6a7b8c9d0e
required_permission: page.create
required_permission_scope: website
required_credential_scope: write
required:
- type
- title
- status
- instance
properties:
type:
type: string
format: uri
title:
type: string
status:
type: integer
detail:
type: string
instance:
type: string
request_id:
type:
- string
- 'null'
errors:
type: array
items:
type: object
additionalProperties: false
required:
- field
- detail
properties:
field:
type: string
detail:
type: string
code:
type: string
upgrade_url:
type: string
required_permission:
type:
- string
- 'null'
description: Declared endpoint permission; null for account-level endpoints with no resource permission.
required_permission_scope:
type:
- string
- 'null'
description: Scope the permission resolves in (workspace, website, environment); null when there is no resource permission.
required_credential_scope:
type:
- string
- 'null'
description: The read/write scope the presented bearer credential lacks; present on credential-ceiling 403s.
retry_after_seconds:
type: integer
minimum: 1
description: Seconds until the quota resets (RFC 9457 extension member, on too-many-requests only). Authoritative over retry_at when clocks differ.
retry_at:
type: string
format: date-time
description: UTC "not before" timestamp — when the quota window ends (RFC 9457 extension member, on too-many-requests only).
suggested_path:
type: string
description: First free path for a restore whose original path is taken, when one can be suggested (RFC 9457 extension member; nothing is renamed automatically).
template_pages:
type: array
description: Live template pages that reference a table whose deletion was refused (RFC 9457 extension member).
items:
type: object
additionalProperties: false
required:
- id
- path
properties:
id:
type: string
format: uuid
path:
type: string
conflicts:
type: array
description: Release items edited by someone else after the caller's last edit (RFC 9457 extension member).
items:
type: object
additionalProperties: false
required:
- type
- identifier
- mine_version
- latest_version
- latest_author
properties:
type:
type: string
identifier:
type: string
mine_version:
type: integer
latest_version:
type: integer
latest_author:
type:
- string
- 'null'
matches:
type: array
description: Candidate short ids for an ambiguous feedback reference (RFC 9457 extension member).
items:
type: string
items:
type: array
description: Identifiers that made a release selection invalid (RFC 9457 extension member).
items:
type: string
nameservers:
type: array
description: Live parent NS answer that still delegates a zone to PageWeave, sent with a refused zone deletion (RFC 9457 extension member).
items:
type: string
existing_id:
type: string
format: uuid
description: Identifier of the existing resource that caused a conflict, such as a pending invitation (RFC 9457 extension member).
SubmissionUpdateRequest:
type: object
additionalProperties: false
minProperties: 1
properties:
read:
type: boolean
spam_verdict:
type: string
enum:
- ham
- quarantined
SubmissionSummary:
type: object
additionalProperties: false
required:
- id
- form_id
- form_version_id
- read
- spam_verdict
- spam_score
- spam_overridden
- email_verification_status
- data
- page_url
- created_at
- updated_at
properties:
id:
type: string
format: uuid
form_id:
type: string
format: uuid
form_version_id:
type: string
format: uuid
read:
type: boolean
spam_verdict:
type: string
enum:
- ham
- quarantined
- discarded
- incomplete
spam_score:
type: integer
spam_overridden:
type: boolean
email_verification_status:
type: string
enum:
- not_required
- pending
- verified
- failed
description: 'Double opt-in state. Pending/failed `ham` rows are hidden from list
and detail responses; quarantined/discarded rows remain visible.
'
data:
type: object
description: Non-file submitted fields. File fields are in `uploads` on detail.
additionalProperties:
oneOf:
- type: string
- type: array
items:
type: string
page_url:
description: 'URL of the page the form was submitted on. Null when it could
not be captured (older submissions, direct API posts, stripped
referrers).
'
type:
- string
- 'null'
format: uri
maxLength: 2048
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
SubmissionDetail:
type: object
additionalProperties: false
required:
- id
- form_id
- form_version_id
- read
- spam_verdict
- spam_score
- spam_overridden
- email_verification_status
- data
- page_url
- spam_signals
- failure_details
- uploads
- deliveries
- confirmation_email
- created_at
- updated_at
properties:
id:
type: string
format: uuid
form_id:
type: string
format: uuid
form_version_id:
type: string
format: uuid
read:
type: boolean
spam_verdict:
type: string
enum:
- ham
- quarantined
- discarded
- incomplete
spam_score:
type: integer
spam_overridden:
type: boolean
email_verification_status:
type: string
enum:
- not_required
- pending
- verified
- failed
description: 'Double opt-in state. Pending/failed `ham` rows are hidden from list
and detail responses; quarantined/discarded rows remain visible.
'
data:
type: object
additionalProperties:
oneOf:
- type: string
- type: array
items:
type: string
page_url:
description: 'URL of the page the form was submitted on. Null when it could
not be captured (older submissions, direct API posts, stripped
referrers).
'
type:
- string
- 'null'
format: uri
maxLength: 2048
spam_signals:
type:
- object
- 'null'
failure_details:
type:
- object
- 'null'
uploads:
type: array
items:
$ref: '#/components/schemas/SubmissionUpload'
deliveries:
type: array
description: 'One row per form recipient (at most 10). The full
`recipient_email` is returned only to callers with
`form.recipient.manage`; `recipient_email_masked` is always
present.
'
items:
$ref: '#/components/schemas/SubmissionDelivery'
confirmation_email:
description: 'The visitor-facing confirmation email. Null when none was
attempted: the form has it off, the submission is spam, or no
email field resolved a recipient.
'
oneOf:
- $ref: '#/components/schemas/SubmissionConfirmationEmail'
- type: 'null'
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
Pagination:
type: object
additionalProperties: false
required:
- limit
- has_more
- next_cursor
properties:
limit:
type: integer
minimum: 0
has_more:
type: boolean
next_cursor:
type:
- string
- 'null'
SubmissionConfirmationEmail:
type: object
additionalProperties: false
required:
- status
- recipient_email
- locale
- sent_at
- delivered_at
- failure_class
- reason
- attempts_count
properties:
status:
type: string
enum:
- pending
- sending
- sent
- held
- delivered
- skipped
- failed
recipient_email:
type: string
format: email
locale:
type: string
sent_at:
type:
- string
- 'null'
format: date-time
delivered_at:
type:
- string
- 'null'
format: date-time
failure_class:
type:
- string
- 'null'
enum:
- hard_bounce
- soft_bounce
- provider_error
- internal_error
- null
reason:
type:
- string
- 'null'
attempts_count:
type: integer
minimum: 0
SubmissionDelivery:
type: object
additionalProperties: false
required:
- id
- recipient_id
- recipient_email
- recipient_email_masked
- status
- failure_class
- reason
- attempts_count
- notified_at
- held_at
- hold_expires_at
- next_attempt_at
- created_at
- updated_at
properties:
id:
type: string
format: uuid
recipient_id:
type: string
format: uuid
description: The form recipient this delivery targets.
recipient_email:
type:
- string
- 'null'
format: email
description: Null unless the caller has form.recipient.manage.
recipient_email_masked:
type: string
status:
type: string
enum:
- pending
- sending
- sent
- held
- delivered
- skipped
- failed
- expired
description: 'Delivery state, not inbox placement: `sent` means the provider
accepted the message, `delivered` means the recipient''s server did.
'
failure_class:
type:
- string
- 'null'
enum:
- hard_bounce
- soft_bounce
- provider_error
- internal_error
- null
reason:
type:
- string
- 'null'
description: Internal reason code, never a provider message.
attempts_count:
type: integer
minimum: 0
notified_at:
type:
- string
- 'null'
format: date-time
held_at:
type:
- string
- 'null'
format: date-time
hold_expires_at:
type:
- string
- 'null'
format: date-time
next_attempt_at:
type:
- string
- 'null'
format: date-time
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
SubmissionsCollection:
type: object
additionalProperties: false
required:
- data
- pagination
properties:
data:
type: array
items:
$ref: '#/components/schemas/SubmissionSummary'
pagination:
$ref: '#/components/schemas/Pagination'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: 'API key created in Settings → API keys. Send
`Authorization: Bearer pagew_...`. A key''s scopes (`read`, `write`) are
a ceiling: a read-only key cannot write even when its owner''s role
allows it.
'