PageWeave Email addresses API

The Email addresses API from PageWeave — 4 operation(s) for email addresses.

GitHub OpenAPI

Operations 6

GET /api/v1/me/email_addresses List trusted notification addresses #
POST /api/v1/me/email_addresses Add a trusted notification address #
POST /api/v1/me/email_addresses/resume Resume a paused address #
GET /api/v1/me/email_addresses/{id} Get a trusted notification address #
DELETE /api/v1/me/email_addresses/{id} Remove a trusted notification address #
POST /api/v1/me/email_addresses/{id}/verification Resend a verification link #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/pageweave-dev:pageweave-dev-email-addresses-api"
All apis
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.

Get an API 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 Specification

pageweave-dev-email-addresses-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: PageWeave Email addresses 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: Email addresses
paths:
  /api/v1/me/email_addresses:
    get:
      operationId: listEmailAddresses
      summary: List trusted notification addresses
      description: 'The primary account email first (implicit, `id` null), then the

        secondaries created for form notifications. `deliverable` is false

        while an address is unverified or suppressed. The response is

        `no-store`.'
      tags:
      - Email addresses
      security:
      - bearerAuth: []
      x-required-permission: null
      x-required-scope: account
      x-required-credential: read
      responses:
        '200':
          description: The bounded address collection
          headers:
            CacheControl:
              $ref: '#/components/headers/CacheControl'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailAddressesCollection'
              example:
                data:
                - id: null
                  email: owner@example.com
                  primary: true
                  status: verified
                  deliverable: true
                  suppression_reason: null
                  verified_at: null
                  verification_sent_at: null
                  created_at: '2026-01-04T09:00:00Z'
                  updated_at: '2026-11-01T12:00:00Z'
                - id: 019f9c2a-6a1b-7a3d-8f2e-4b6c8d0e1f23
                  email: alerts@example.com
                  primary: false
                  status: pending
                  deliverable: false
                  suppression_reason: null
                  verified_at: null
                  verification_sent_at: '2026-11-04T12:00:00Z'
                  created_at: '2026-11-04T12:00:00Z'
                  updated_at: '2026-11-04T12:00:00Z'
                pagination:
                  limit: 2
                  has_more: false
                  next_cursor: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
    post:
      operationId: createEmailAddress
      summary: Add a trusted notification address
      description: 'Creates a pending secondary address and mails its ownership proof. An

        address the caller already proved is returned unchanged with `200`; a

        new one is `201`. Verification mail is throttled per address (5

        minutes) and per account (20 a day): a throttled add keeps the row and

        reports `verification_sent: false` with `retry_after_seconds` instead

        of claiming mail went out. The response is `no-store`.'
      tags:
      - Email addresses
      security:
      - bearerAuth: []
      x-required-permission: null
      x-required-scope: account
      x-required-credential: write
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailAddressRequest'
            example:
              email: alerts@example.com
      responses:
        '201':
          description: The new pending address and its verification outcome
          headers:
            Location:
              $ref: '#/components/headers/Location'
            CacheControl:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailAddressWriteResult'
              example:
                email_address:
                  id: 019f9c2a-6a1b-7a3d-8f2e-4b6c8d0e1f23
                  email: alerts@example.com
                  primary: false
                  status: pending
                  deliverable: false
                  suppression_reason: null
                  verified_at: null
                  verification_sent_at: '2026-11-04T12:00:00Z'
                  created_at: '2026-11-04T12:00:00Z'
                  updated_at: '2026-11-04T12:00:00Z'
                verification_sent: true
                retry_after_seconds: null
        '200':
          description: The existing address, with the verification outcome
          headers:
            Location:
              $ref: '#/components/headers/Location'
            CacheControl:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailAddressWriteResult'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '422':
          $ref: '#/components/responses/Unprocessable'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /api/v1/me/email_addresses/resume:
    post:
      operationId: resumeEmailAddress
      summary: Resume a paused address
      description: 'Clears an address-wide `unsubscribed` suppression so future form

        notifications reach the mailbox again. Only an address the caller has

        proved qualifies: the verified primary account email or a verified

        secondary. A hard bounce is not clearable here. Old undigested

        notifications are not replayed. The response is `no-store`.'
      tags:
      - Email addresses
      security:
      - bearerAuth: []
      x-required-permission: null
      x-required-scope: account
      x-required-credential: write
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailAddressResumeRequest'
            example:
              email: owner@example.com
      responses:
        '200':
          description: The resumed address
          headers:
            CacheControl:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailAddress'
              example:
                id: null
                email: owner@example.com
                primary: true
                status: verified
                deliverable: true
                suppression_reason: null
                verified_at: null
                verification_sent_at: null
                created_at: '2026-01-04T09:00:00Z'
                updated_at: '2026-11-04T12:00:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '429':
          $ref: '#/components/responses/TooManyRequests'
  /api/v1/me/email_addresses/{id}:
    parameters:
    - name: id
      in: path
      required: true
      description: Secondary address identifier (the primary has no id).
      schema:
        type: string
        format: uuid
    get:
      operationId: getEmailAddress
      summary: Get a trusted notification address
      description: The response is `no-store`.
      tags:
      - Email addresses
      security:
      - bearerAuth: []
      x-required-permission: null
      x-required-scope: account
      x-required-credential: read
      responses:
        '200':
          description: One secondary address
          headers:
            CacheControl:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailAddress'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
    delete:
      operationId: deleteEmailAddress
      summary: Remove a trusted notification address
      description: 'Removes a secondary address. Linked form subscriptions unsubscribe

        with reason `owner_removed`; the address itself is not suppressed

        platform-wide, so the recipient can still resume from a notification

        link. The primary account email cannot be removed. The response is

        `no-store`.'
      tags:
      - Email addresses
      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'
  /api/v1/me/email_addresses/{id}/verification:
    parameters:
    - name: id
      in: path
      required: true
      description: Secondary address identifier.
      schema:
        type: string
        format: uuid
    post:
      operationId: resendEmailAddressVerification
      summary: Resend a verification link
      description: 'Sends a fresh ownership proof for a pending address; the previous link

        stops working. A verified address answers `409`. The per-address

        window (5 minutes) and the per-account daily cap answer `429` with

        `Retry-After`, so the 429 is never stored as an idempotent replay. The

        response is `no-store`.'
      tags:
      - Email addresses
      security:
      - bearerAuth: []
      x-required-permission: null
      x-required-scope: account
      x-required-credential: write
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '202':
          description: Verification mail accepted for delivery
          headers:
            Location:
              $ref: '#/components/headers/Location'
            CacheControl:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailAddressWriteResult'
        '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'
components:
  headers:
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
    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'
    CacheControl:
      description: Cache directives for this response (`no-store` for capability URLs).
      schema:
        type: string
    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
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: 'Replay-safe key for POST, including bodyless action POSTs such as

        revert (1-255 printable ASCII characters,

        draft-ietf-httpapi-idempotency-key-header-08). A replay returns the

        stored response with `Idempotent-Replayed: true`.


        Responses up to 64 KB are stored and replayed in full. Larger responses

        keep only status and headers; their replay is bodyless and carries

        `Idempotent-Replay-Body-Omitted: true` (follow `Location`). Each user

        may hold 10,000 unexpired records across credentials; a new key past

        the cap returns 429 with `Retry-After`, while an existing key still

        replays.

        '
      schema:
        type: string
        minLength: 1
        maxLength: 255
  schemas:
    EmailAddress:
      type: object
      additionalProperties: false
      required:
      - id
      - email
      - primary
      - status
      - deliverable
      - suppression_reason
      - verified_at
      - verification_sent_at
      - created_at
      - updated_at
      properties:
        id:
          type:
          - string
          - 'null'
          format: uuid
          description: Null for the implicit primary account email, which has no stored row.
        email:
          type: string
          format: email
        primary:
          type: boolean
        status:
          type: string
          enum:
          - verified
          - pending
        deliverable:
          type: boolean
          description: True only when the address is verified and not suppressed.
        suppression_reason:
          type:
          - string
          - 'null'
          enum:
          - hard_bounce
          - unsubscribed
          - null
        verified_at:
          type:
          - string
          - 'null'
          format: date-time
        verification_sent_at:
          type:
          - string
          - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    EmailAddressResumeRequest:
      type: object
      additionalProperties: false
      required:
      - email
      properties:
        email:
          type: string
          format: email
          maxLength: 320
    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).
    EmailAddressRequest:
      type: object
      additionalProperties: false
      required:
      - email
      properties:
        email:
          type: string
          format: email
          maxLength: 320
    EmailAddressWriteResult:
      type: object
      additionalProperties: false
      required:
      - email_address
      - verification_sent
      - retry_after_seconds
      properties:
        email_address:
          $ref: '#/components/schemas/EmailAddress'
        verification_sent:
          type: boolean
          description: False when the throttle suppressed the mail; the address row still exists.
        retry_after_seconds:
          type:
          - integer
          - 'null'
          minimum: 1
    EmailAddressesCollection:
      type: object
      additionalProperties: false
      required:
      - data
      - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
        pagination:
          $ref: '#/components/schemas/Pagination'
    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'
  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.

        '