Command Palette

Search for a command to run...

Log In
Get help

List Budgets for a Participant

get/public/v1/participants/{participant}/budgets

Budgets are the participant's Schedule of Supports — the planned funding that feeds a service agreement. Line items and funding periods are read from their own endpoints; the allocation of individual line items across funding periods is not exposed.

Authorization

  • Authorizationstringrequired

    Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

  • participantstringrequired

    The participant UUID

Query parameters

  • filter[archived]string

    Filter by archive status. Omit to return both active and archived budgets. One of: active, archived.

    Example:active
  • filter[search]string

    Partial match on the budget name.

    Example:Schedule of Supports
  • sortstring

    Sort the results. Prefix with '-' for descending. One of: name, created_at.

    Example:-created_at
  • page[size]integer

    Number of results per page. Minimum 1, maximum 100.

    Default:25
  • page[number]integer

    The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.

    Default:1

Response

200application/json

Paginated set of BudgetResource

  • dataobject[]required
    ▶Show 10 child attributes
    • idstringrequired
      Example:b1u2d3g4-e5t6-47a8-9b0c-1d2e3f4a5b6c
    • namestringrequired
      Example:2026 Schedule of Supports
    • descriptionstring | nullrequired
      Example:Initial quote for the 2026 plan period
    • typestringrequired
      Example:internal
    • startstringrequired
      Example:2026-01-01T00:00:00+00:00
    • endstringrequired
      Example:2026-12-31T00:00:00+00:00
    • totalintegerrequired
      Example:4500000
    • has_funding_schedulebooleanrequired
      Example:true
    • archived_atstring | nullrequired
    • created_atstringrequired
      Example:2026-01-01T09:00:00+00:00
  • metaobjectrequired
    ▶Show 5 child attributes
    • current_pageintegerrequired≥ 1
    • last_pageintegerrequired≥ 1
    • per_pageintegerrequired≥ 0

      Number of items shown per page.

    • totalintegerrequired≥ 0

      Total number of items being paginated.

    • allowed_sortsstring[]required

      The list of allowed sorts for this endpoint.

Errors

  • 401Unauthenticated
  • 403Authorization error
  • 404Not found