v1

latestOpenAPI 3.1.02026-08-065163115.0 KB

Budgets

List budgets

get/v1/businesses/{client_id}/budgets

Path parameters

client_idinteger required

Example:123

The ID of the business.

Query parameters

offsetinteger

Example:50

Offset to retrieve items from.

limitinteger

Example:50

Number of items per page.

is_deletedboolean

Whether the resource is deleted.

budget_type'BUDGET' | 'SUBSCRIPTION'

Example:BUDGET

The type of budget.

has_member_limitsboolean

Whether the budget has member limits.

Response

countinteger

The total number of budgets that match the query.

nextstring

The URL to the next page of budgets.

previousstring

The URL to the previous page of budgets.

Example response

{
  "count": 100,
  "next": "offset=50&limit=50",
  "previous": "offset=0&limit=50",
  "results": [
    {
      "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
      "name": "Sales Team",
      "budget_type": "BUDGET",
      "available_amount": 800,
      "spent_amount": 200,
      "reset_amount": 1000,
      "reset_period": "MONTHLY",
      "current_period_start": "2024-01-01T00:00:00Z",
      "current_period_end": "2024-01-31T23:59:59Z",
      "categories": [
        {
          "id": "7f183748-c7fb-428a-9b2a-603a03dcabdb",
          "name": "Travel"
        }
      ],
      "custom_fields": [
        {
          "id": "44b2add5-eeb2-456c-8918-9bb362b0e896",
          "name": "Department"
        }
      ],
      "created": "2024-01-01T00:00:00Z",
      "updated": "2024-01-01T00:00:00Z"
    }
  ]
}