Inboxy Account API

Caller identity.

GitHub OpenAPI

Operations 1

GET /v1/account Get caller's account snapshot — user, quota, rate-limits, retention #

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/inboxy-net:inboxy-net-account-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. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

inboxy-net-account-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: inboxy Account API
  version: 0.3.0
  summary: Read + manage your inboxy.net inbox programmatically.
  description: 'REST surface over the inboxy alias inbox. Mint aliases, list/search/read

    messages, fetch attachments, manage your API keys, and emit user-initiated

    mail under one of your aliases.


    Mail-emitting paths (`POST /v1/messages/{id}/reply`, `POST /v1/mail/send`,

    `POST /v1/mail/invite`) are recipient-locked and alias-locked server-side:

    the `From:` is always one of the caller''s `@inboxy.net` aliases, the

    recipient is validated against per-user caps and the abuse rules in

    `packages/reply`, and every external message carries the mandatory

    inboxy attribution footer. There is no arbitrary-`From:` send path.


    All endpoints require a bearer API key created from the inboxy.net web UI

    at `/account/keys` (mint is gated by step-up and lives only on the web — there

    is no API-channel mint). Pass it as `Authorization: Bearer ik_…`.


    The signed-token attachment download URLs (`/v1/attachments/{token}/download`,

    `/v1/messages/raw/{token}/download`) are public-by-token — they intentionally

    bypass bearer auth and are not listed here. Obtain them via the JSON

    endpoints below.'
  contact:
    name: inboxy
    url: https://inboxy.net
  license:
    name: Proprietary
servers:
- url: https://api.inboxy.net
  description: Production
security:
- bearerAuth: []
tags:
- name: Account
  description: Caller identity.
paths:
  /v1/account:
    get:
      tags:
      - Account
      summary: Get caller's account snapshot — user, quota, rate-limits, retention
      description: Returns one blob agents can use to decide whether an action is allowed (e.g. compare `quota.feeds.used` against `quota.feeds.limit` before calling `feed_add`). Same shape on api and mcp.
      responses:
        '200':
          description: Account snapshot.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountSnapshot'
        '401':
          $ref: '#/components/responses/Unauthorized'
      operationId: getV1Account
      x-operation-id-source: derived
components:
  schemas:
    AccountSnapshot:
      type: object
      required:
      - user
      - subscription
      - quota
      - rate_limits
      - retention
      properties:
        user:
          type: object
          required:
          - id
          - personal_email
          - plan
          - forward_rewrite_links
          properties:
            id:
              type: string
              format: uuid
            personal_email:
              type: string
              format: email
            timezone:
              type:
              - string
              - 'null'
            plan:
              type: string
              enum:
              - free
              - paid
              - pro
            forward_rewrite_links:
              type: boolean
        subscription:
          type: object
          required:
          - name
          - plan_id
          - since
          - renews_at
          - cancels_at
          description: Subscription card. `name` is the customer-facing plan name; `plan_id` is the immutable plan version the account is pinned to (limits only change when an operator moves the account to a new version). `renews_at` / `cancels_at` are currently always null — not yet wired to live Stripe subscription state.
          properties:
            name:
              type: string
              example: Free
            plan_id:
              type: string
              example: free_v1
            since:
              type: string
              format: date-time
            renews_at:
              type:
              - string
              - 'null'
              format: date-time
            cancels_at:
              type:
              - string
              - 'null'
              format: date-time
        quota:
          type: object
          required:
          - addresses
          - agent_addresses
          - feeds
          - api_keys
          - kept_messages
          properties:
            addresses:
              type: object
              required:
              - used
              - limit
              properties:
                used:
                  type: integer
                  minimum: 0
                limit:
                  type: integer
                  minimum: 0
            agent_addresses:
              type: object
              description: Separate allowance for `agent-…` and `<domain>-…` aliases.
              required:
              - used
              - limit
              properties:
                used:
                  type: integer
                  minimum: 0
                limit:
                  type: integer
                  minimum: 0
            feeds:
              type: object
              required:
              - used
              - limit
              properties:
                used:
                  type: integer
                  minimum: 0
                limit:
                  type: integer
                  minimum: 0
            api_keys:
              type: object
              required:
              - active
              properties:
                active:
                  type: integer
                  minimum: 0
            kept_messages:
              type: object
              required:
              - used
              - limit
              description: Per-user retention pins. 10 hard cap for all plans v1.
              properties:
                used:
                  type: integer
                  minimum: 0
                limit:
                  type: integer
                  minimum: 0
            mail_import:
              type: object
              required:
              - used
              - limit
              - period_resets_at
              description: Historic-mail imports (`POST /v1/mail/import`) this UTC calendar month against the plan's cap (`limit`). Duplicates are refunded.
              properties:
                used:
                  type: integer
                  minimum: 0
                limit:
                  type: integer
                  minimum: 0
                period_resets_at:
                  type: string
                  format: date-time
        rate_limits:
          type: object
          required:
          - requests_per_min
          - forward_per_hour
          - reply_per_hour
          - feed_add_per_hour
          - feed_refresh_per_hour
          description: Caller-visible caps so agents can self-throttle.
          properties:
            requests_per_min:
              type: integer
              minimum: 1
            forward_per_hour:
              type: integer
              minimum: 0
            reply_per_hour:
              type: integer
              minimum: 0
            feed_add_per_hour:
              type: integer
              minimum: 0
            feed_refresh_per_hour:
              type: integer
              minimum: 0
        retention:
          type: object
          required:
          - message_body_days
          properties:
            message_body_days:
              type: integer
              description: Days a message body is kept before the daily retention sweep purges it. Set by the account's plan; a per-account override takes precedence. Messages pinned with mail_keep are exempt. Always a concrete window — never null.
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - bad_request
          - unauthorized
          - forbidden
          - not_found
          - gone
          - rate_limited
          - internal
          - invalid_token
          - blocked
        message:
          type: string
  responses:
    Unauthorized:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: ik_…
      description: Static API key. Three scopes — `read` (everything except mutations), `manage` (mutations other than sending) and `send` (`/v1/mail/send`, replies, invites). Mint at https://inboxy.net/account/keys (the web UI gates mint with step-up; there is no API-channel mint).