PageWeave Roles API
The Roles API from PageWeave — 3 operation(s) for roles.
The Roles API from PageWeave — 3 operation(s) for roles.
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-roles-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 Roles 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: Roles
paths:
/api/v1/workspaces/{workspace_id}/roles:
parameters:
- name: workspace_id
in: path
required: true
description: Workspace UUID or slug.
schema:
type: string
get:
operationId: listRoles
summary: List roles
description: System and custom roles, bounded; no cursor parameters.
tags:
- Roles
security:
- bearerAuth: []
x-required-permission: workspace.role.read
x-required-scope: workspace
x-required-credential: read
parameters:
- name: scope
in: query
required: false
description: Restrict to workspace- or website-scoped roles.
schema:
type: string
enum:
- workspace
- website
responses:
'200':
description: Roles
content:
application/json:
schema:
$ref: '#/components/schemas/RolesCollection'
'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'
post:
operationId: createRole
summary: Create a custom role
description: The author may only bundle permissions they already hold.
tags:
- Roles
security:
- bearerAuth: []
x-required-permission: workspace.role.create
x-required-scope: workspace
x-required-credential: write
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RoleCreateRequest'
responses:
'201':
description: The created role
headers:
Location:
$ref: '#/components/headers/Location'
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'422':
$ref: '#/components/responses/Unprocessable'
'429':
$ref: '#/components/responses/TooManyRequests'
/api/v1/workspaces/{workspace_id}/roles/{role_scope}/{role_key}:
parameters:
- name: workspace_id
in: path
required: true
description: Workspace UUID or slug.
schema:
type: string
- name: role_scope
in: path
required: true
description: Role scope.
schema:
type: string
enum:
- workspace
- website
- name: role_key
in: path
required: true
description: Role key.
schema:
type: string
pattern: ^[a-z][a-z0-9_]*$
get:
operationId: getRole
summary: Get a role
tags:
- Roles
security:
- bearerAuth: []
x-required-permission: workspace.role.read
x-required-scope: workspace
x-required-credential: read
parameters:
- $ref: '#/components/parameters/IfNoneMatch'
responses:
'200':
description: The role
headers:
ETag:
$ref: '#/components/headers/ETag'
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
'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: updateRole
summary: Edit a custom role
description: System roles are immutable.
tags:
- Roles
security:
- bearerAuth: []
x-required-permission: workspace.role.update
x-required-scope: workspace
x-required-credential: write
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RoleUpdateRequest'
responses:
'200':
description: The updated role
headers:
ETag:
$ref: '#/components/headers/ETag'
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'422':
$ref: '#/components/responses/Unprocessable'
'429':
$ref: '#/components/responses/TooManyRequests'
delete:
operationId: deleteRole
summary: Delete a custom role
description: System roles cannot be deleted; a role still assigned returns 409.
tags:
- Roles
security:
- bearerAuth: []
x-required-permission: workspace.role.delete
x-required-scope: workspace
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'
'409':
$ref: '#/components/responses/Conflict'
'429':
$ref: '#/components/responses/TooManyRequests'
/api/v1/workspaces/{workspace_id}/permissions:
parameters:
- name: workspace_id
in: path
required: true
description: Workspace UUID or slug.
schema:
type: string
get:
operationId: listPermissions
summary: List the permission catalog
description: Bounded reference data for building custom roles.
tags:
- Roles
security:
- bearerAuth: []
x-required-permission: workspace.role.read
x-required-scope: workspace
x-required-credential: read
responses:
'200':
description: Permission catalog
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionsCollection'
'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
Location:
description: Canonical URL of the created or affected resource.
schema:
type: string
format: uri
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:
Conflict:
description: The request conflicts with the current state (replayed key, in-progress operation)
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
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:
RolesCollection:
type: object
additionalProperties: false
required:
- data
- pagination
properties:
data:
type: array
items:
$ref: '#/components/schemas/Role'
pagination:
$ref: '#/components/schemas/Pagination'
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).
Permission:
type: object
additionalProperties: false
required:
- key
- scope
- description
properties:
key:
type: string
scope:
type: string
enum:
- workspace
- website
- environment
description:
type: string
RoleCreateRequest:
type: object
additionalProperties: false
required:
- scope
- key
- name
- permissions
properties:
scope:
type: string
enum:
- workspace
- website
key:
type: string
pattern: ^[a-z][a-z0-9_]*$
name:
type: string
maxLength: 60
description:
type:
- string
- 'null'
permissions:
type: array
minItems: 1
items:
type: string
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'
PermissionsCollection:
type: object
additionalProperties: false
required:
- data
- pagination
properties:
data:
type: array
items:
$ref: '#/components/schemas/Permission'
pagination:
$ref: '#/components/schemas/Pagination'
RoleUpdateRequest:
type: object
additionalProperties: false
properties:
name:
type: string
maxLength: 60
description:
type:
- string
- 'null'
permissions:
type: array
minItems: 1
items:
type: string
Role:
type: object
additionalProperties: false
required:
- key
- scope
- name
- description
- system
- assigned
- permissions
properties:
key:
type: string
scope:
type: string
enum:
- workspace
- website
name:
type: string
description:
type:
- string
- 'null'
system:
type: boolean
assigned:
type: boolean
permissions:
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.
'