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

# List Budgets

> Returns a page of the workspace's Budgets, optionally filtered by `state` (`active` or `paused`). Each Budget carries its immutable scope, metric, and window plus current thresholds and `version`. Pass that `version` as `expected_version` when patching.

Checkfu support posture: alpha; hosted. Required evidence journey: governance-registry. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.



## OpenAPI

````yaml /openapi.json get /v1/budgets
openapi: 3.1.0
info:
  title: Checkfu API
  version: '2026-08-27'
  description: >-
    Authentication is declared per operation: API-key, runtime, or connector
    bearer; Automation signature; or credential-free pairing redemption. Every
    general Checkfu REST request requires the dated `Checkfu-Version` header
    (one of: 2026-08-27); the three MCP JSON-RPC transports use
    `MCP-Protocol-Version`, A2A uses `A2A-Version`, and the provider OAuth
    callback carries neither Checkfu header. API keys resolve one Workspace
    without a request selector; authenticated responses identify it with
    `Checkfu-Workspace-Id`.
servers:
  - url: https://api.checkfu.com
security:
  - bearerAuth: []
tags:
  - name: organizations
  - name: sourceRepositories
  - name: tenants
  - name: workspaces
  - name: principals
  - name: principalGroups
  - name: principalAccessCredentials
  - name: apiKeys
  - name: agents
  - name: harnesses
  - name: harnessRuntime
  - name: sandboxProfiles
  - name: computerProfiles
  - name: permissionAssignments
  - name: actionPolicies
  - name: files
  - name: memoryStores
  - name: dreams
  - name: modelCredentials
  - name: modelRoutingProfiles
  - name: blueprintInstallations
  - name: toolSources
  - name: skills
  - name: skillSources
  - name: agentSources
  - name: skillProposals
  - name: instructionProposals
  - name: catalog
  - name: concepts
  - name: support
  - name: connections
  - name: connectionVaults
  - name: connectionAssignments
  - name: connectedRuntimes
  - name: projects
  - name: collaboration
  - name: automationGraphs
  - name: automations
  - name: actionApprovals
  - name: standingApprovals
  - name: usage
  - name: models
  - name: outcomes
  - name: budgets
  - name: billing
  - name: sessions
  - name: audit
  - name: sessionExports
  - name: runs
  - name: runnerPools
  - name: transcripts
  - name: sessionWatches
  - name: webhookEndpoints
  - name: integrationGateway
  - name: agentDeployments
  - name: workEnvironments
  - name: computers
  - name: computerScreens
  - name: computerBrowserObservations
  - name: computerBrowserActions
  - name: environments
  - name: vaults
  - name: apiMcp
  - name: a2a
paths:
  /v1/budgets:
    get:
      tags:
        - budgets
      summary: List Budgets
      description: >-
        Returns a page of the workspace's Budgets, optionally filtered by
        `state` (`active` or `paused`). Each Budget carries its immutable scope,
        metric, and window plus current thresholds and `version`. Pass that
        `version` as `expected_version` when patching.


        Checkfu support posture: alpha; hosted. Required evidence journey:
        governance-registry. Deployment-specific readiness and the latest proven
        release are available from GET /v1/support/capabilities.
      operationId: budgets.listBudgets
      parameters:
        - name: checkfu-version
          in: header
          schema:
            type: string
            enum:
              - '2026-08-27'
          required: true
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
          required: false
        - name: page
          in: query
          schema:
            type: string
            allOf:
              - pattern: ^c1_[0-9a-z]+$
          required: false
        - name: state
          in: query
          schema:
            type: string
            enum:
              - active
              - paused
          required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BudgetSessionLifetimeWindowScope_1'
                  next_page:
                    anyOf:
                      - type: string
                      - type: 'null'
                required:
                  - data
                  - next_page
                additionalProperties: false
          headers:
            checkfu-workspace-id:
              description: The Workspace resolved from the authenticated bearer credential.
              required: true
              schema:
                $ref: '#/components/schemas/WorkspaceId'
        '400':
          description: Typed Checkfu wire error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationMalformedError'
        '401':
          description: Typed Checkfu wire error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - type
                      - message
                      - more
                    properties:
                      type:
                        type: string
                        enum:
                          - auth.invalid_key
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#auth-invalid-key
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    additionalProperties: false
                additionalProperties: false
        '403':
          description: >-
            The organization, tenant, or workspace backing this key is
            administratively disabled. | Deployment governance or retention
            policy denied the request.
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - auth.disabled_tenancy
                          message:
                            type: string
                          more:
                            type: string
                            enum:
                              - >-
                                https://docs.checkfu.com/reference/errors#auth-disabled-tenancy
                            description: >-
                              Stable public documentation and remedy for this
                              error type.
                        required:
                          - type
                          - message
                          - more
                        additionalProperties: false
                    additionalProperties: false
                  - $ref: '#/components/schemas/PolicyDeniedError'
        '429':
          description: Typed Checkfu wire error
          headers:
            retry-after:
              description: >-
                Delay in seconds for rate limits or deployment quotas with a
                known release or UTC reset boundary
              required: false
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - type
                      - message
                      - more
                    properties:
                      type:
                        type: string
                        enum:
                          - budget.exceeded
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#budget-exceeded
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    additionalProperties: false
                additionalProperties: false
        '500':
          description: >-
            An unexpected internal failure occurred; the message contains an
            opaque incident reference.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeInternalError'
      security:
        - bearerAuth: []
components:
  schemas:
    BudgetSessionLifetimeWindowScope_1:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/BudgetId'
        workspace_id:
          $ref: '#/components/schemas/WorkspaceId'
        scope:
          $ref: '#/components/schemas/Union_287'
        metric:
          $ref: '#/components/schemas/Union_216'
        window:
          $ref: '#/components/schemas/Union_288'
        soft_threshold:
          $ref: '#/components/schemas/Union_289'
        hard_threshold:
          $ref: '#/components/schemas/Objects_160'
        state:
          $ref: '#/components/schemas/Union_290'
        version:
          $ref: '#/components/schemas/BudgetPositiveSafeInteger'
        created_at:
          type: string
        updated_at:
          type: string
      required:
        - id
        - workspace_id
        - scope
        - metric
        - window
        - soft_threshold
        - hard_threshold
        - state
        - version
        - created_at
        - updated_at
      additionalProperties: false
    WorkspaceId:
      type: string
      allOf:
        - pattern: ^wrkspc_[0-9a-f]{32}$
    ValidationMalformedError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.malformed
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#validation-malformed
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        The request could not be decoded or violated a declared input
        constraint.
    PolicyDeniedError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - policy.denied
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#policy-denied
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: Deployment governance or retention policy denied the request.
    RuntimeInternalError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - runtime.internal
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#runtime-internal
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        An unexpected internal failure occurred; the message contains an opaque
        incident reference.
    BudgetId:
      type: string
      allOf:
        - pattern: ^bgt_[0-9a-f]{32}$
    Union_287:
      anyOf:
        - type: object
          properties:
            kind:
              type: string
              enum:
                - workspace
            agent_definition_id: false
            principal_id: false
            surface_scope_id: false
            automation_id: false
            session_id: false
          required:
            - kind
          additionalProperties: false
        - type: object
          properties:
            kind:
              type: string
              enum:
                - agent_definition
            agent_definition_id:
              $ref: '#/components/schemas/AgentId'
            principal_id: false
            surface_scope_id: false
            automation_id: false
            session_id: false
          required:
            - kind
            - agent_definition_id
          additionalProperties: false
        - type: object
          properties:
            kind:
              type: string
              enum:
                - principal
            principal_id:
              $ref: '#/components/schemas/PrincipalId'
            agent_definition_id: false
            surface_scope_id: false
            automation_id: false
            session_id: false
          required:
            - kind
            - principal_id
          additionalProperties: false
        - type: object
          properties:
            kind:
              type: string
              enum:
                - surface_scope
            surface_scope_id:
              $ref: '#/components/schemas/SurfaceScopeId'
            agent_definition_id: false
            principal_id: false
            automation_id: false
            session_id: false
          required:
            - kind
            - surface_scope_id
          additionalProperties: false
        - type: object
          properties:
            kind:
              type: string
              enum:
                - automation
            automation_id:
              $ref: '#/components/schemas/AutomationId'
            agent_definition_id: false
            principal_id: false
            surface_scope_id: false
            session_id: false
          required:
            - kind
            - automation_id
          additionalProperties: false
        - type: object
          properties:
            kind:
              type: string
              enum:
                - session
            session_id:
              $ref: '#/components/schemas/SessionId'
            agent_definition_id: false
            principal_id: false
            surface_scope_id: false
            automation_id: false
          required:
            - kind
            - session_id
          additionalProperties: false
    Union_216:
      type: string
      enum:
        - model_tokens
        - model_spend
        - session_runtime_ms
        - total_spend
    Union_288:
      anyOf:
        - type: object
          properties:
            kind:
              type: string
              enum:
                - rolling
            duration_seconds:
              $ref: '#/components/schemas/BudgetPositiveSafeInteger'
          required:
            - kind
            - duration_seconds
          additionalProperties: false
        - type: object
          properties:
            kind:
              type: string
              enum:
                - calendar_month
            duration_seconds: false
          required:
            - kind
          additionalProperties: false
        - type: object
          properties:
            kind:
              type: string
              enum:
                - session_lifetime
            duration_seconds: false
          required:
            - kind
          additionalProperties: false
    Union_289:
      anyOf:
        - $ref: '#/components/schemas/Objects_159'
        - type: 'null'
    Objects_160:
      type: object
      properties:
        limit:
          $ref: '#/components/schemas/BudgetPositiveSafeInteger'
        breach_action:
          type: string
          enum:
            - block_admission
            - interrupt_turn
            - pause_session
      required:
        - limit
        - breach_action
      additionalProperties: false
    Union_290:
      type: string
      enum:
        - active
        - paused
    BudgetPositiveSafeInteger:
      type: integer
      allOf:
        - exclusiveMinimum: 0
    AgentId:
      type: string
      allOf:
        - pattern: ^agent_[0-9a-f]{32}$
    PrincipalId:
      type: string
      allOf:
        - pattern: ^prin_[0-9a-f]{32}$
    SurfaceScopeId:
      type: string
      allOf:
        - pattern: ^surf_[0-9a-f]{32}$
    AutomationId:
      type: string
      allOf:
        - pattern: ^auto_[0-9a-f]{32}$
    SessionId:
      type: string
      allOf:
        - pattern: ^sess_[0-9a-f]{32}$
    Objects_159:
      type: object
      properties:
        limit:
          $ref: '#/components/schemas/BudgetPositiveSafeInteger'
        action:
          type: string
          enum:
            - notify
      required:
        - limit
        - action
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````