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

# Get orgsmeworkspace health



## OpenAPI

````yaml /openapi.json get /orgs/me/workspace-health
openapi: 3.1.1
info:
  title: Anima API
  version: 0.1.0
  description: >-
    The Anima API provides programmatic access to unified infrastructure for AI
    agents: create and manage agents; send and receive email; place phone calls
    and send/receive SMS and voice; store and retrieve vault credentials; manage
    agent identity; and configure webhooks for real-time events. Authenticate
    using a Bearer token or an API key passed via the X-API-Key header.
  contact:
    name: Anima Labs
    url: https://useanima.sh
    email: support@useanima.sh
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.useanima.sh/v1
    description: Production
security:
  - BearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: Agents
    description: Create and manage AI agents with email and phone capabilities
  - name: Inboxes
    description: Manage email inboxes and their configurations
  - name: Messages
    description: Send, receive, and search email messages
  - name: Webhooks
    description: Register and manage webhook subscriptions for real-time events
  - name: Organizations
    description: Manage organizations and team settings
  - name: Domains
    description: Configure and verify custom email domains
  - name: Phone
    description: Manage phone numbers and SMS/voice capabilities
  - name: Invoices
    description: Track invoices, match receipts, and reconcile payments
  - name: Billing
    description: View usage, tiers, and billing information
  - name: Security
    description: Configure security policies and access controls
  - name: Vault
    description: Store and retrieve encrypted secrets
  - name: API Keys
    description: Create and manage API keys for programmatic access
paths:
  /orgs/me/workspace-health:
    get:
      operationId: org.workspaceHealth
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    enum:
                      - ok
                      - degraded
                    type: string
                    description: >-
                      Overall workspace status. degraded if any blocker is
                      present.
                  org:
                    type: object
                    properties:
                      id:
                        type: string
                        pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
                      name:
                        type: string
                      tier:
                        type: string
                        description: Current billing tier (FREE / GROWTH / SCALE / ...)
                      signupStatus:
                        type: string
                        description: active / pending_review / suspended
                    required:
                      - id
                      - name
                      - tier
                      - signupStatus
                    description: Organization context
                  auth:
                    type: object
                    properties:
                      keyType:
                        enum:
                          - master
                          - agent
                        type: string
                        description: >-
                          Whether the calling credential is master-tier or
                          agent-tier
                      authMethod:
                        enum:
                          - api_key
                          - clerk
                          - scoped_token
                        type: string
                        description: How the credential was authenticated
                      agentId:
                        anyOf:
                          - type: string
                          - type: 'null'
                        description: >-
                          Agent ID if the credential is agent-bound, null for
                          master
                      scopes:
                        type: array
                        items:
                          type: string
                        description: Granted scopes for OAuth / scoped tokens
                    required:
                      - keyType
                      - authMethod
                      - agentId
                    description: Credential context — same data Who_Am_I would surface
                  capabilities:
                    type: object
                    properties:
                      canSendEmail:
                        type: boolean
                        description: >-
                          True iff at least one verified email identity exists
                          across the org's agents
                      canSendSms:
                        type: boolean
                        description: >-
                          True iff at least one phone identity has SMS
                          capability and is past 10DLC
                    required:
                      - canSendEmail
                      - canSendSms
                    description: Cross-cutting send capability summary
                  inventory:
                    type: object
                    properties:
                      agents:
                        type: integer
                        minimum: 0
                      agentsReadyToSend:
                        type: integer
                        minimum: 0
                        description: Subset of agents whose primary identity is verified
                      domains:
                        type: integer
                        minimum: 0
                      domainsVerified:
                        type: integer
                        minimum: 0
                      phoneNumbers:
                        type: integer
                        minimum: 0
                    required:
                      - agents
                      - agentsReadyToSend
                      - domains
                      - domainsVerified
                      - phoneNumbers
                    description: Inventory counts useful for self-diagnosis
                  blockers:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          description: Stable code (e.g. ORG_SUSPENDED, NO_VERIFIED_DOMAIN)
                        hint:
                          type: string
                          description: Human-readable remediation
                      required:
                        - code
                        - hint
                    description: >-
                      All currently-blocking conditions; empty array means
                      status:'ok'
                required:
                  - status
                  - org
                  - auth
                  - capabilities
                  - inventory
                  - blockers
                description: >-
                  Per-workspace health summary callable by any authenticated
                  credential
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Bearer token obtained from authentication. Pass as: Authorization:
        Bearer <token>
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API key for programmatic access. Pass as: X-API-Key: <your-key>'

````