Boardwalk Account API

openapi: 3.2.0
info:
  title: Boardwalkai Com Account API
  version: '2026-09-16'
  contact:
    name: Boardwalk Support
    email: support@boardwalkai.com
    url: https://boardwalkai.com
  description: 'Operations tagged Account across 2 of this provider''s published API definitions: boardwalkai-com-openapi.json, boardwalkai-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.boardwalkai.com/api/v1
  description: Production
- url: http://localhost:8000/api/v1
  description: Local development
security:
- bearerAuth: []
tags:
- name: Account
  description: Plan, credit balance, and rate-limit info for the authenticated key.
paths:
  /account/credits:
    get:
      tags:
      - Account
      summary: Credit balance and plan info
      description: Returns the current billing-period credit balance and the rate limit for the authenticated API key. Free.
      responses:
        '200':
          description: Credit balance.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditBalanceResponse'
          headers:
            X-Boardwalk-Schema-Version:
              $ref: '#/components/headers/BoardwalkSchemaVersion'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
      operationId: getAccountCredits
      x-operation-id-source: derived
    servers:
    - url: https://api.boardwalkai.com/api/v1
      description: Production
    - url: http://localhost:8000/api/v1
      description: Local development
  /account/preferences:
    get:
      tags:
      - Account
      summary: Saved search preferences (free)
      description: 'Types, geography, optional website, and optional thumbs on example projects. Empty when first-run has not happened. A teammate with no row of their own inherits the team owner''s blob (`inheritedFromTeam: true`). **Free.**'
      responses:
        '200':
          description: Preferences blob. `meta.creditsUsed` is 0.
          headers:
            X-Boardwalk-Schema-Version:
              $ref: '#/components/headers/BoardwalkSchemaVersion'
        '401':
          $ref: '#/components/responses/Unauthorized'
      operationId: getAccountPreferences
      x-operation-id-source: derived
    patch:
      tags:
      - Account
      summary: Update search preferences (free)
      description: Merge the fields you send onto the caller's own row (never onto an inherited team row). **Free.**
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                lookingFor:
                  type: array
                  items:
                    type: string
                geography:
                  type: object
                website:
                  type:
                  - string
                  - 'null'
                notes:
                  type:
                  - string
                  - 'null'
                exampleProjectFeedback:
                  type: array
                firstRunCompleted:
                  type: boolean
      responses:
        '200':
          description: The saved blob.
          headers:
            X-Boardwalk-Schema-Version:
              $ref: '#/components/headers/BoardwalkSchemaVersion'
        '400':
          description: Unknown field or invalid value.
          headers:
            X-Boardwalk-Schema-Version:
              $ref: '#/components/headers/BoardwalkSchemaVersion'
        '401':
          $ref: '#/components/responses/Unauthorized'
      operationId: patchAccountPreferences
      x-operation-id-source: derived
    servers:
    - url: https://api.boardwalkai.com/api/v1
      description: Production
    - url: http://localhost:8000/api/v1
      description: Local development
components:
  responses:
    PaymentRequired:
      description: 'Subscription missing, credits exhausted, or the page this request would deliver costs more than the balance has left.


        * `subscription_required`: no active paid plan or trial behind this key.

        * `credits_exhausted`: the balance cannot cover even one record and this response would have billed at least one. Re-reads of unchanged records you already own bill 0 and are still served at 0 balance. Paid balances refill on the 1st; trial credits never do.

        * `insufficient_credits`: the balance has credits left, but fewer than this page would cost. A page is delivered whole or refused whole, never trimmed, so **no records are returned and nothing is charged**. `details.quote` states the page''s cost, what remains, `affordableRecordCount` (the `limit` to retry with), and a free `countUrl` that re-prices the whole match set. Free-trial pages are truncated instead of refused here; see `meta.trialTruncation`.

        * `enrichment_requires_paid_plan`: `include=contacts` (Find Contact Info) needs a paid plan or a live trial. Record credits may still remain. Drop the parameter, start a trial, or upgrade.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            error:
              code: credits_exhausted
              message: You have used all your API credits for this billing period. Credits reset on the 1st of each month.
              param: null
              details:
                creditsUsed: 5000
                creditsLimit: 5000
                resetsAt: '2026-06-01T00:00:00Z'
              docsUrl: https://boardwalkai.com/docs/api/errors#credits_exhausted
              requestId: req_01K1QF3M0000EXAMPLE0001
      headers:
        X-Boardwalk-Schema-Version:
          $ref: '#/components/headers/BoardwalkSchemaVersion'
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            error:
              code: missing_api_key
              message: 'API key is required. Include it as Authorization: Bearer bwk_live_... or X-API-Key: bwk_live_...'
              param: null
              details: {}
              docsUrl: https://boardwalkai.com/docs/api/errors#missing_api_key
              requestId: req_01K1QF3M0000EXAMPLE0001
      headers:
        X-Boardwalk-Schema-Version:
          $ref: '#/components/headers/BoardwalkSchemaVersion'
  schemas:
    CreditBalanceResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            plan:
              type: string
              description: Internal plan name (e.g. `single_state`).
            planDisplayName:
              type: string
              description: Human-friendly plan label (e.g. `1 State`).
            creditsLimit:
              type: integer
            creditsUsed:
              type: integer
            creditsRemaining:
              type: integer
            periodStart:
              type: string
              format: date
            periodEnd:
              type: string
              format: date
            resetsAt:
              type:
              - string
              - 'null'
              format: date-time
              description: Next reset instant. Null for a one-off trial allowance.
            rateLimit:
              type: integer
            rateLimitPer:
              type: string
              example: minute
            isTeamPool:
              type: boolean
              description: Whether this balance is shared by a team.
            poolUserId:
              type: integer
              description: Owner of the credit pool used by this key.
            enrichment:
              type:
              - object
              - 'null'
              description: 'The monthly enrichment allowance: the same meter `POST /enrichments` reports as `EnrichmentAllowance`, spelled with longer key names here. Null when enrichment is not wired for this environment.'
              properties:
                monthlyAttemptsLimit:
                  type:
                  - integer
                  - 'null'
                  description: Null means the plan carries no explicit cap.
                attemptsUsed:
                  type: integer
                attemptsRemaining:
                  type:
                  - integer
                  - 'null'
                resetsAt:
                  type: string
                  format: date-time
        meta:
          type: object
          required:
          - requestId
          properties:
            requestId:
              type: string
              description: Matches X-Request-Id.
    ApiError:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          - param
          - details
          - docsUrl
          - requestId
          properties:
            code:
              type: string
              description: Stable machine-readable code. Branch on this value.
            message:
              type: string
              description: Human-readable explanation. Do not parse it.
            param:
              type:
              - string
              - 'null'
              description: The offending input parameter, when applicable.
            details:
              type: object
              description: Structured, camelCase context. Always an object, empty when there is no context.
              additionalProperties: true
            docsUrl:
              type: string
              format: uri
              description: Documentation for this exact error code.
            requestId:
              type: string
              description: Matches X-Request-Id and the server-side usage/log record.
          additionalProperties: false
      additionalProperties: false
  headers:
    BoardwalkSchemaVersion:
      description: The date-stamped response contract version. Present on every public v1 response.
      schema:
        type: string
        example: '2026-09-16'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Boardwalk API key. Keys you create under Settings → API are prefixed `bwk_live_` and read the production corpus against your plan or free-trial balance. `bwk_test_` is reserved for a separate sandbox environment that is not serving data yet. Pre-rename `csk_` keys are accepted indefinitely. Create and rotate keys at https://boardwalkai.com/profile/api.
x-refined-from:
- boardwalkai-com-openapi.json
- boardwalkai-com-openapi.yml