blinkinbox-club Inboxes API

openapi: 3.2.0
info:
  title: BlinkInbox Inboxes API
  version: 1.0.0
  description: Programmable disposable inboxes for end-to-end tests, QA and AI agents. Create an inbox, trigger your signup flow, then wait for the email and read the OTP code or magic link.
  contact:
    name: BlinkInbox
    url: https://blinkinbox.club/contact
servers:
- url: https://api.blinkinbox.club/api/v1
security:
- bearerAuth: []
tags:
- name: Inboxes
paths:
  /inboxes:
    post:
      tags:
      - Inboxes
      operationId: createInbox
      summary: Create an inbox
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                prefix:
                  type: string
                  example: signup
                  description: Address starts with this, followed by 8 random characters.
                localPart:
                  type: string
                  example: qa-bot
                  description: Exact local part. Custom domains, or Pro on the shared domain.
                domain:
                  type: string
                  example: test.acme.dev
                  description: A verified custom domain. Defaults to the shared domain.
                ttlMinutes:
                  type: integer
                  example: 60
                  description: Lifetime; max depends on plan.
                label:
                  type: string
                  example: 'checkout-e2e #4821'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Inbox'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
    get:
      tags:
      - Inboxes
      operationId: listInboxes
      summary: List your inboxes
      parameters:
      - name: active
        in: query
        schema:
          type: boolean
      - name: limit
        in: query
        schema:
          type: integer
          maximum: 100
      - name: page
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Inbox'
                  total:
                    type: integer
                  page:
                    type: integer
                  limit:
                    type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
  /inboxes/{inbox}:
    parameters:
    - name: inbox
      in: path
      required: true
      description: Inbox id or full address (e.g. `signup4k2j9x1a@blinkinbox.club`).
      schema:
        type: string
    get:
      tags:
      - Inboxes
      operationId: getInbox
      summary: Get an inbox
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Inbox'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
    delete:
      tags:
      - Inboxes
      operationId: deleteInbox
      summary: Delete an inbox and all its mail
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Success'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  responses:
    NotFound:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Rate limit or quota exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Success:
      type: object
      properties:
        success:
          type: boolean
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
    Inbox:
      type: object
      properties:
        id:
          type: string
        address:
          type: string
          example: signup4k2j9x1a@blinkinbox.club
        localPart:
          type: string
        domain:
          type: string
        label:
          type: string
        source:
          type: string
          enum:
          - web
          - api
          - mcp
        active:
          type: boolean
        createdAt:
          type: string
          format: date-time
        expiresAt:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key from the dashboard, e.g. `bb_live_...`. `X-API-Key` header also works.