PageWeave Account API
The Account API from PageWeave — 5 operation(s) for account.
The Account API from PageWeave — 5 operation(s) for account.
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-account-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 Account 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: Account
paths:
/api/v1/me:
get:
operationId: getMe
summary: Current user
description: The authenticated user's profile.
tags:
- Account
security:
- bearerAuth: []
x-required-permission: null
x-required-scope: account
x-required-credential: read
parameters:
- $ref: '#/components/parameters/IfNoneMatch'
responses:
'200':
description: The authenticated user
headers:
ETag:
$ref: '#/components/headers/ETag'
Last-Modified:
$ref: '#/components/headers/LastModified'
content:
application/json:
schema:
$ref: '#/components/schemas/User'
example:
id: 0190b3f4-6c1a-7c2e-9f7a-2f5f6f1a9c31
name: Ada Lovelace
email: ada@example.com
language: en
status: verified
created_at: '2026-03-02T09:14:08Z'
updated_at: '2026-10-28T16:40:12Z'
'304':
$ref: '#/components/responses/NotModified'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
patch:
operationId: updateMe
summary: Update the current user
description: Edits the caller's own name and language. Email changes stay in the account settings flow.
tags:
- Account
security:
- bearerAuth: []
x-required-permission: null
x-required-scope: account
x-required-credential: write
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProfileUpdateRequest'
responses:
'200':
description: The updated user
headers:
ETag:
$ref: '#/components/headers/ETag'
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'422':
$ref: '#/components/responses/Unprocessable'
'429':
$ref: '#/components/responses/TooManyRequests'
/api/v1/me/account:
get:
operationId: getAccount
summary: Account state
description: Verification status, plan limits, and usage counts for the authenticated account.
tags:
- Account
security:
- bearerAuth: []
x-required-permission: null
x-required-scope: account
x-required-credential: read
responses:
'200':
description: Account state
headers:
ETag:
$ref: '#/components/headers/ETag'
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
'304':
$ref: '#/components/responses/NotModified'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/api/v1/me/permissions:
get:
operationId: getMyPermissions
summary: Effective permissions
description: 'The caller''s effective authorization in an optional workspace, website,
or environment context. With no context the default workspace is used.
`roles` shows which assignment won at each level (environment > website
> workspace); `permissions` is the bundle that role resolves to.'
tags:
- Account
security:
- bearerAuth: []
x-required-permission: null
x-required-scope: account
x-required-credential: read
parameters:
- name: workspace_id
in: query
required: false
description: Workspace UUID or slug.
schema:
type: string
- name: website_id
in: query
required: false
description: Website UUID or subdomain.
schema:
type: string
- name: environment_id
in: query
required: false
description: Environment UUID or name. Requires `website_id`.
schema:
type: string
- $ref: '#/components/parameters/IfNoneMatch'
responses:
'200':
description: Effective roles and permission bundles
headers:
ETag:
$ref: '#/components/headers/ETag'
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionContext'
'304':
$ref: '#/components/responses/NotModified'
'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/me/authorized_applications:
get:
operationId: listAuthorizedApplications
summary: List authorized OAuth applications
description: Bounded collection; no cursor parameters.
tags:
- Account
security:
- bearerAuth: []
x-required-permission: null
x-required-scope: account
x-required-credential: read
responses:
'200':
description: Applications the caller authorized
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizedApplicationsCollection'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
/api/v1/me/authorized_applications/{id}:
parameters:
- name: id
in: path
required: true
description: OAuth application identifier.
schema:
type: integer
delete:
operationId: revokeAuthorizedApplication
summary: Revoke an OAuth application
description: Revokes the caller's tokens and grants for the application.
tags:
- Account
security:
- bearerAuth: []
x-required-permission: null
x-required-scope: account
x-required-credential: write
responses:
'204':
$ref: '#/components/responses/NoContent'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'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
NotModified:
description: The representation has not changed
headers:
ETag:
$ref: '#/components/headers/ETag'
schemas:
User:
type: object
additionalProperties: false
required:
- id
- name
- email
- language
- status
- created_at
- updated_at
properties:
id:
type: string
format: uuid
name:
type:
- string
- 'null'
email:
type: string
language:
type: string
status:
type: string
enum:
- unverified
- verified
- closed
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
ProfileUpdateRequest:
type: object
additionalProperties: false
properties:
name:
type: string
language:
type: string
enum:
- de
- en
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).
AuthorizedApplicationsCollection:
type: object
additionalProperties: false
required:
- data
- pagination
properties:
data:
type: array
items:
$ref: '#/components/schemas/AuthorizedApplication'
pagination:
$ref: '#/components/schemas/Pagination'
AuthorizedApplication:
type: object
additionalProperties: false
required:
- id
- name
- scopes
- first_authorized_at
- created_at
properties:
id:
type: integer
name:
type: string
scopes:
type: array
items:
type: string
first_authorized_at:
type:
- string
- 'null'
format: date-time
created_at:
type: string
format: date-time
Account:
type: object
additionalProperties: false
required:
- id
- name
- email
- language
- status
- created_at
- updated_at
- verified
- default_workspace_id
- limits
- counts
properties:
id:
type: string
format: uuid
name:
type:
- string
- 'null'
email:
type: string
language:
type: string
status:
type: string
enum:
- unverified
- verified
- closed
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
verified:
type: boolean
default_workspace_id:
type:
- string
- 'null'
format: uuid
limits:
type: object
additionalProperties: false
required:
- free_website_limit
- total_website_limit
- effective_free_website_limit
- effective_total_website_limit
properties:
free_website_limit:
type:
- integer
- 'null'
total_website_limit:
type:
- integer
- 'null'
effective_free_website_limit:
type: integer
effective_total_website_limit:
type: integer
counts:
type: object
additionalProperties: false
required:
- websites
- workspaces
properties:
websites:
type: integer
workspaces:
type: integer
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'
PermissionContext:
type: object
additionalProperties: false
required:
- workspace_id
- website_id
- environment_id
- roles
- permissions
properties:
workspace_id:
type:
- string
- 'null'
format: uuid
website_id:
type:
- string
- 'null'
format: uuid
environment_id:
type:
- string
- 'null'
format: uuid
roles:
type: object
additionalProperties: false
required:
- workspace
- website
- environment
properties:
workspace:
type:
- string
- 'null'
website:
type:
- string
- 'null'
environment:
type:
- string
- 'null'
permissions:
type: object
additionalProperties: false
required:
- workspace
- website
- environment
properties:
workspace:
type: array
items:
type: string
website:
type: array
items:
type: string
environment:
type: array
items:
type: string
parameters:
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
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.
'