> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sandywp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Exchange an authorization code for an access token

> RFC 6749 authorization-code exchange with required S256 PKCE verification. It authenticates the request with the code, registered client, redirect URI, and verifier rather than a bearer token or client secret. Send either JSON or `application/x-www-form-urlencoded` with the same fields.



## OpenAPI

````yaml /openapi.yaml post /api/connect/token
openapi: 3.1.0
info:
  title: SandyWP API
  version: 0.1.0
  summary: Complete supported customer API for SandyWP automation.
  description: >
    This is the complete supported customer API for automating SandyWP
    sandboxes, reusable

    Templates and Blueprints, Imports, Workspaces, account credentials, and
    OAuth connection setup.

    It is the stable HTTP contract for developer integrations; browser,
    provider, and operations

    routes on the same host are deliberately not part of this document.


    **Exclusions ledger.** The specification excludes guest/launcher creation
    (`POST /api/sites`),

    account profile/avatar/password/support and GitHub UI handlers, billing
    checkout/portal/sync,

    public launch routes, plugin/theme search proxies, storage, activity
    telemetry, newsletter,

    health, metrics, impersonation, Slack/GitHub callbacks, Git/Polar webhooks,
    all `/api/admin/**`,

    and all `/api/internal/**` worker or SSH-control routes. Those endpoints are
    browser backends,

    provider callbacks, or operational control-plane interfaces rather than
    supported developer APIs.


    ## Conventions


    - Requests and responses are JSON. Send `Content-Type: application/json` on
    writes (the file
      upload and plugin-ZIP-upload endpoints instead use `multipart/form-data`, as noted on those
      operations).
    - Sandboxes and Templates are addressed by their opaque `id` in the API (for
    example
      `site_abc123`, `tpl_xyz789`).
    - Errors use a consistent envelope — see the `Error` schema. Some actions
    require a paid plan
      and fail with HTTP `402` and a specific error code (for example
      `template_sharing_requires_paid_plan`); each is called out on the operation that returns it.
    - **Async by default.** Provisioning and other slow sandbox mutations happen
    on a worker, not
      inline in the HTTP request. An endpoint that starts one either returns a `jobId` to poll (see
      the `Job` / `JobSummary` schemas and each operation's description), returns the resource in a
      non-terminal state (a site `"creating"`, a Template `"building"`) to re-fetch until it settles,
      or both.
    - A personal bearer token can call the authenticated operations below. A
    scoped OAuth token is
      accepted only by `GET /api/account/me` and the Imports family; it needs `import:read` or
      `import:write` for the matching import operation. Other REST operations treat scoped tokens
      as unauthenticated.
  contact:
    name: SandyWP
    url: https://app.sandywp.com/docs/api
servers:
  - url: https://app.sandywp.com
security:
  - bearerAuth: []
tags:
  - name: Templates
    description: >-
      A Template is a snapshot of a finished sandbox — WordPress/PHP versions,
      plugins, themes, content, and database — ready to restore in seconds.
      Templates come from saving a ready sandbox, and can optionally be
      published as a public "launch this demo" link.
  - name: Sites
    description: >-
      A Site is a disposable WordPress sandbox: its lifecycle
      (create/restore/reset/delete) and the per-sandbox tools built on top of it
      (PHP runtime & ini config, WordPress debug settings, database access,
      outgoing-email capture, plugin deploys, the file manager, Git deployment,
      and SSH access).
  - name: Blueprints
    description: >-
      Reviewable WordPress build recipes that can be validated, saved, run on a
      sandbox, or baked into a Template.
  - name: Imports
    description: >-
      Archive-upload workflows for cloning a live WordPress site or pushing a
      local installation. Scoped OAuth tokens may use only this family, with
      `import:read` for reads and `import:write` for mutations.
  - name: Workspaces
    description: Workspace selection plus member and custom-role administration.
  - name: Account
    description: Identity, usage, personal API tokens, and account SSH public keys.
  - name: OAuth
    description: >-
      Public-client registration and PKCE authorization-code token exchange for
      supported connectors.
paths:
  /api/connect/token:
    post:
      tags:
        - OAuth
      summary: Exchange an authorization code for an access token
      description: >-
        RFC 6749 authorization-code exchange with required S256 PKCE
        verification. It authenticates the request with the code, registered
        client, redirect URI, and verifier rather than a bearer token or client
        secret. Send either JSON or `application/x-www-form-urlencoded` with the
        same fields.
      operationId: exchangeOAuthAuthorizationCode
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OAuthTokenExchangeRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/OAuthTokenExchangeRequest'
      responses:
        '200':
          description: >-
            A scoped bearer access token. Cloner exchanges also include the
            connected account and site.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthTokenExchangeResponse'
        '400':
          description: >-
            Standard SandyWP error envelope: `invalid_request`,
            `unsupported_grant_type`, `invalid_client`, `invalid_grant`,
            `invalid_target`, or another exchange-validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security: []
components:
  schemas:
    OAuthTokenExchangeRequest:
      type: object
      required:
        - grant_type
        - code
        - client_id
        - redirect_uri
        - code_verifier
      properties:
        grant_type:
          type: string
          enum:
            - authorization_code
        code:
          type: string
          description: Short-lived, single-use authorization code.
        client_id:
          type: string
        redirect_uri:
          type: string
          format: uri
          description: Must exactly match the URI used in the authorization request.
        code_verifier:
          type: string
          minLength: 43
          maxLength: 128
          description: RFC 7636 S256 PKCE verifier.
        resource:
          type: string
          format: uri
          description: >-
            Optional RFC 8707 resource indicator. If presented, it must match
            the authorization request.
    OAuthTokenExchangeResponse:
      type: object
      required:
        - access_token
        - token_type
        - scope
      properties:
        access_token:
          type: string
          description: >-
            Scoped bearer token. Store it securely; the response has no refresh
            token.
        token_type:
          type: string
          enum:
            - Bearer
        scope:
          type: string
          description: Space-separated granted scopes.
        account_email:
          type: string
          format: email
          description: Present for SandyWP Cloner exchanges.
        site_url:
          type: string
          format: uri
          description: Present for SandyWP Cloner exchanges.
    Error:
      type: object
      description: >-
        The standard error envelope returned by every endpoint on a non-2xx
        response.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: >-
                A stable, machine-readable error code (e.g. `invalid_request`,
                `site_not_found`, `plan_limit_reached`). See each operation for
                the codes it can return.
              example: invalid_request
            message:
              type: string
              description: A human-readable message. Safe to display to an end user.
            details:
              type: object
              description: >-
                Optional structured context (e.g. `{"plan": "free", "limit": 2}`
                for a plan-limit error). Omitted entirely on the generic
                internal-error fallback; `{}` when an error has no extra
                context.
              additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Personal API token, sent as `Authorization: Bearer <SANDYWP_API_KEY>`.
        Obtain one from the dashboard account menu (API keys), `sandywp auth
        login`, or `POST /api/account/tokens`. A missing or invalid token
        returns `401 auth_required`. Scoped OAuth tokens are limited to the
        Imports family and `GET /api/account/me`; see the top-level conventions.

````