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

# Get account status

> Read onboarding state, capabilities and current limits with the saved API key.

Requires the agent-onboarding API release. See [Set up your agent](/agent-install)
for credential handling, safe retries and the human claim flow.

Check `sending_status` and `capabilities.send` before attempting to send. A claimed
account can still be paused. `usage.received_messages` and `usage.received_bytes`
track the onboarding receive quota, not lifetime or billing usage after claim.
An expired account can read its status here but cannot read inbox/message contents.


## OpenAPI

````yaml GET /account
openapi: 3.1.0
info:
  title: SentFromAI API
  version: 0.1.0
  description: >-
    Comms infrastructure for AI agents. Email send/receive, threading,
    attachments, drafts, webhooks, realtime, and search.
servers:
  - url: https://api.sentfrom.ai/v1
security:
  - bearerAuth: []
tags:
  - name: account
    description: >-
      Agent bootstrap and human ownership claim status; signup requires the
      staged rollout to be enabled.
  - name: inboxes
  - name: messages
  - name: threads
  - name: drafts
  - name: webhooks
  - name: labels
  - name: lists
  - name: attachments
  - name: domains
    description: Custom sending domains
paths:
  /account:
    get:
      tags:
        - account
      summary: Get account state, capabilities and limits
      description: >-
        Use the original API key to resume setup. Includes existing inboxes.
        Account status remains available after unclaimed expiry; ordinary
        inbox/message reads do not. Claimed send capability does not bypass
        plan, warming, suppression or abuse checks.
      operationId: getAccountStatus
      responses:
        '200':
          description: Current account state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountStatus'
        '401':
          description: Missing, invalid or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingError'
        '403':
          description: Account is suspended.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingError'
        '404':
          description: account_not_found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingError'
components:
  schemas:
    AccountStatus:
      type: object
      properties:
        tenant_id:
          type: string
        name:
          type: string
        onboarding_state:
          type: string
          enum:
            - unclaimed
            - claimed
        claimed_at:
          type:
            - string
            - 'null'
          format: date-time
        sending_enabled_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Claim-time start of sending warmup for agent-created accounts.
        unclaimed_expires_at:
          type:
            - string
            - 'null'
          format: date-time
        expired:
          type: boolean
        capabilities:
          $ref: '#/components/schemas/AccountCapabilities'
        limits:
          $ref: '#/components/schemas/AccountLimits'
        usage:
          type: object
          properties:
            received_messages:
              type: integer
              minimum: 0
            received_bytes:
              type: integer
              minimum: 0
          required:
            - received_messages
            - received_bytes
          description: >-
            Counters consumed by the unclaimed onboarding receive quota. These
            are not lifetime or billing usage after claim.
        inboxes:
          type: array
          items:
            $ref: '#/components/schemas/AccountInbox'
        sending_status:
          type: string
          enum:
            - enabled
            - paused
            - unclaimed
            - expired
            - suspended
          description: >-
            Current sending readiness. Check this together with
            capabilities.send; enabled remains subject to plan, warming,
            suppression and abuse checks.
        sending_paused_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When sending was paused, or null if no current pause is recorded.
      required:
        - tenant_id
        - name
        - onboarding_state
        - claimed_at
        - sending_enabled_at
        - unclaimed_expires_at
        - expired
        - capabilities
        - limits
        - usage
        - inboxes
        - sending_status
        - sending_paused_at
    OnboardingError:
      type: object
      properties:
        error:
          type: string
          description: Machine-readable error code.
        message:
          type: string
          description: Explanation and recovery guidance.
      required:
        - error
    AccountCapabilities:
      type: object
      properties:
        receive:
          type: boolean
          description: Account may receive, subject to quotas and message limits.
        read:
          type: boolean
          description: Account may read its existing inbox and mail.
        send:
          type: boolean
          description: >-
            Account ownership and sending status permit sending. False while
            paused. Plan, warming, suppression and abuse checks still apply.
        manage:
          type: boolean
          description: >-
            Ownership permits resource mutations; plan limits still apply.
            Unclaimed accounts may only refresh claim links.
      required:
        - receive
        - read
        - send
        - manage
    AccountLimits:
      type: object
      properties:
        inboxes:
          type: integer
          minimum: 1
          description: Inbox cap. One while unclaimed; plan-specific after claim.
        received_messages:
          type:
            - integer
            - 'null'
          minimum: 0
          description: >-
            Cumulative unclaimed inbound message cap, default 50. Null means no
            onboarding-specific cap; plan limits still apply.
        received_bytes:
          type:
            - integer
            - 'null'
          minimum: 0
          description: >-
            Cumulative unclaimed inbound byte cap, default 10485760 (10 MiB).
            Null after claim; plan limits still apply.
      required:
        - inboxes
        - received_messages
        - received_bytes
    AccountInbox:
      type: object
      properties:
        id:
          type: string
        address:
          type: string
          format: email
      required:
        - id
        - address
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.