List Budgets

GET

https://{{env}}-lb.simplifipay.com/v1/budget

Budget

This endpoint retrieves a paginated list of budgets, optionally filtered by entityType
(CARD_PROGRAM, TEAM or CARD_GROUP).

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Query Params

Header Params

Responses

🟢200

application/json

Bodyapplication/json

🟠401UnauthorizedError

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://uat-lb.simplifipay.com/v1/budget?entityType=undefined&includeBudget=undefined&page=undefined&size=undefined' \
--header 'requestUuid;' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "budgets": [
        {
            "uuid": "string",
            "name": "string",
            "entityType": "CARD_PROGRAM",
            "entityUuid": "string",
            "budget": 0,
            "frequency": "string",
            "currency": "string",
            "utilizedBudget": 0,
            "status": "ACTIVE",
            "startDate": "2019-08-24",
            "endDate": "2019-08-24",
            "creationDate": "2019-08-24T14:15:22.123Z",
            "updatedDate": "2019-08-24T14:15:22.123Z"
        }
    ],
    "total": 0
}

Modified at 2026-09-15 04:11:46

Create a Budget

Get a Budget