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

# List Budgets

> 
        Retrieve a list of budgets with optional filtering and sorting.

        Supports including soft-deleted records for audit and recovery purposes.
        When include_deleted=true, returns ONLY deleted records instead of active records.
        Deleted records contain minimal data: 'id', 'is_deleted=true', 'deleted_at' timestamp,
        and 'last_modified_at'. When 'false' or omitted, returns ONLY active records.
        This provides clean separation between active and deleted data.
        



## OpenAPI

````yaml https://api.meetcampfire.com/api/schema?format=json get /coa/api/budgets
openapi: 3.0.3
info:
  title: Campfire Developer APIs
  version: 1.0.0
  description: >
    ## Introduction

    Campfire's developer APIs offer granular access to Campfire's core
    accounting,

    revenue recognition, and financial data features.


    These APIs are designed to be used by developers to build custom
    integrations,

    automate workflows, and perform any other programmatic operations.
servers:
  - url: https://api.meetcampfire.com
    description: Production server
security: []
tags:
  - name: Cash Management
    description: Operations related to accounts, transactions, and other bank-related data.
  - name: Core Accounting
    description: >-
      Operations related to core accounting data, such as the chart of accounts,
      entity management, and the general ledger.
  - name: Revenue Recognition
    description: >-
      Operations related to revenue recognition, contract management, and
      contract data aggregation.
  - name: Accounts Receivable
    description: Operations related to invoicing and the AR subledger
  - name: Accounts Payable
    description: Operations related to billing and the AP subledger.
  - name: Financial Statements
    description: Operations related to financial statement generation and data aggregation.
  - name: Settings
    description: Operations related to system and accounting settings configuration.
paths:
  /coa/api/budgets:
    get:
      tags:
        - Core Accounting
      summary: List Budgets
      description: |2-

                Retrieve a list of budgets with optional filtering and sorting.

                Supports including soft-deleted records for audit and recovery purposes.
                When include_deleted=true, returns ONLY deleted records instead of active records.
                Deleted records contain minimal data: 'id', 'is_deleted=true', 'deleted_at' timestamp,
                and 'last_modified_at'. When 'false' or omitted, returns ONLY active records.
                This provides clean separation between active and deleted data.
                
      operationId: coa_api_budgets_list
      parameters:
        - in: query
          name: entity
          schema:
            type: integer
          description: Filter by entity ID
        - in: query
          name: entity_name
          schema:
            type: string
          description: Filter by entity name (partial match)
        - in: query
          name: include_deleted
          schema:
            type: boolean
            default: false
          description: >-
            When set to 'true', returns ONLY deleted records instead of active
            records. Deleted records contain minimal data: 'id',
            'is_deleted=true', 'deleted_at' timestamp, and 'last_modified_at'.
            When 'false' or omitted, returns ONLY active records. This provides
            clean separation between active and deleted data.
        - in: query
          name: last_modified_at__gte
          schema:
            type: string
          description: >-
            Filter for records modified on or after this timestamp. Format: ISO
            8601 (e.g., '2024-01-01T00:00:00Z' or '2024-01-01'). Works with both
            active records and deleted records (filters by deletion time for
            deleted records).
        - in: query
          name: last_modified_at__lte
          schema:
            type: string
          description: >-
            Filter for records modified on or before this timestamp. Format: ISO
            8601 (e.g., '2024-12-31T23:59:59Z' or '2024-12-31'). Works with both
            active records and deleted records (filters by deletion time for
            deleted records).
        - name: limit
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
        - name: offset
          required: false
          in: query
          description: The initial index from which to return the results.
          schema:
            type: integer
        - in: query
          name: q
          schema:
            type: string
          description: Search query - searches by budget name
        - in: query
          name: sort
          schema:
            type: string
            default: name
          description: >-
            Sort order. Use field name for ascending, -field for descending.
            Supports multiple fields separated by comma. Default: name
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedBudgetList'
          description: ''
      security:
        - knoxApiToken: []
components:
  schemas:
    PaginatedBudgetList:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/Budget'
    Budget:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        entity_name:
          type: string
          readOnly: true
        prior_start_date:
          type: string
          readOnly: true
        prior_end_date:
          type: string
          readOnly: true
        department_name:
          type: string
          readOnly: true
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TransactionTag'
          readOnly: true
        is_deleted:
          type: boolean
          readOnly: true
          default: false
        deleted_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        name:
          type: string
        description:
          type: string
          nullable: true
        cadence:
          type: string
          nullable: true
        start_date:
          type: string
          format: date
        end_date:
          type: string
          format: date
          nullable: true
        periods:
          type: integer
          maximum: 32767
          minimum: 0
        breakdown_type:
          $ref: '#/components/schemas/BreakdownTypeEnum'
        tag_ids:
          type: array
          items:
            type: integer
            maximum: 9223372036854776000
            minimum: -9223372036854776000
            format: int64
        tag_group_ids:
          type: array
          items:
            type: integer
            maximum: 9223372036854776000
            minimum: -9223372036854776000
            format: int64
        currency:
          type: string
          maxLength: 3
        created_at:
          type: string
          format: date-time
          readOnly: true
        last_modified_at:
          type: string
          format: date-time
          readOnly: true
        customer:
          type: integer
          readOnly: true
        entity:
          type: integer
          nullable: true
        department:
          type: integer
          nullable: true
      required:
        - created_at
        - customer
        - deleted_at
        - department_name
        - entity_name
        - id
        - is_deleted
        - last_modified_at
        - name
        - prior_end_date
        - prior_start_date
        - start_date
        - tags
    TransactionTag:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        group_name:
          type: string
          readOnly: true
        parent_name:
          type: string
          readOnly: true
          nullable: true
        parent:
          type: integer
          nullable: true
        is_deleted:
          type: boolean
          readOnly: true
          default: false
        deleted_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        is_active:
          type: boolean
          default: true
        name:
          type: string
          nullable: true
          maxLength: 250
        created_at:
          type: string
          format: date-time
          readOnly: true
        last_modified_at:
          type: string
          format: date-time
          readOnly: true
        customer:
          type: integer
          readOnly: true
        group:
          type: integer
          nullable: true
      required:
        - created_at
        - customer
        - deleted_at
        - group_name
        - id
        - is_deleted
        - last_modified_at
        - name
        - parent_name
    BreakdownTypeEnum:
      enum:
        - standard
        - department_row
      type: string
      description: |-
        * `standard` - Standard (Account-based)
        * `department_row` - Department (Row)
  securitySchemes:
    knoxApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"

````