budgetsList budgets

List budgets

curl -X GET "https://api.403fin.io/v1/budgets?cursor=example_string&page_size=25&active=true" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "John Doe",
      "method_type": "example_string",
      "period_type": "example_string",
      "is_active": true,
      "income_type": "example_string",
      "expected_monthly_income": "example_string",
      "method_meta": {
        "display_name": "John Doe",
        "is_name_editable": true,
        "has_fixed_groups": true
      },
      "enabled_features": [
        "example_string"
      ],
      "target_groups": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "John Doe",
          "sort_order": 42,
          "allocation_type": "example_string",
          "allocation_value": "example_string",
          "items": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "category_id": "123e4567-e89b-12d3-a456-426614174000",
              "allocated_amount": "example_string",
              "spent_amount": "example_string"
            }
          ]
        }
      ],
      "created_at": "2024-12-25T10:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "example_string",
    "has_more": true
  },
  "redacted_fields": [
    "example_string"
  ],
  "filtered": true
}
GET
/v1/budgets
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.

An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.
API Key (header: X-API-Key)
X-API-Keystring
Required

An opaque ff_ credential presented in the X-API-Key header.

An opaque ff_ credential presented in the X-API-Key header.
query
cursorstring

Opaque cursor from a previous response's pagination.next_cursor.

query
page_sizeinteger

Maximum number of items to return.

Format: int32 • Min: 1
query
activeboolean

When true, return only active budgets.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.

header
X-API-Keystring
Required

API Key for authentication. An opaque ff_ credential presented in the X-API-Key header.

Query Parameters

cursorstring

Opaque cursor from a previous response's pagination.next_cursor.

page_sizeinteger

Maximum number of items to return.

activeboolean

When true, return only active budgets.

Responses

dataarray
Required
paginationstring

Cursor pagination state, present on list endpoints.

redacted_fieldsstring[]

Field ids stripped from the payload by connection scope.

filteredboolean

True when row or aggregate filtering is in effect for this response.