Skip to main content
GET
/
api
/
v1
/
budgets
List budgets
curl --request GET \
  --url https://app.sure.am/api/v1/budgets \
  --header 'X-Api-Key: <api-key>'
{
  "budgets": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "start_date": "2023-12-25",
      "end_date": "2023-12-25",
      "name": "<string>",
      "currency": "<string>",
      "initialized": true,
      "current": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "budgeted_spending": "<string>",
      "budgeted_spending_cents": 123,
      "expected_income": "<string>",
      "expected_income_cents": 123,
      "allocated_spending": "<string>",
      "allocated_spending_cents": 123
    }
  ],
  "pagination": {
    "page": 2,
    "per_page": 2,
    "total_count": 1,
    "total_pages": 1
  }
}

Authorizations

​
X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Query Parameters

​
page
integer

Page number (default: 1)

​
per_page
integer

Items per page (default: 25, max: 100)

​
start_date
string<date>

Filter budgets starting on or after this date

​
end_date
string<date>

Filter budgets ending on or before this date

Response

budgets listed

​
budgets
object[]
required
​
pagination
object
required