Returns one expense box. Metadata only — use list_expenses with boxId for planned expenses.
GET
/v1/get_boxQuery
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| budgetId | string | Yes | — | Budget that owns the box. |
| boxId | string | Yes | — | Id of the expense box. |
Response data
| Field | Type | Description |
|---|---|---|
| id | string | Unique id of this expense box. |
| name | string | Human-readable name shown in the app. |
| description | string | Free-text description or memo when present. |
| currency | string | ISO 4217 currency code. |
| amount | number | Amount allocated to this box. |
| sortOrder | number | Sort position when the budget has an explicit order. |
| type | string | Category written by Tools API create/update (e.g. needs / wants / savings). |
| category | string | Category on app-synced boxes (same role as type; may appear instead of or alongside type). |
| icon | string | Icon key when set in the app. |
| iconColor | string | Curated icon circle fill key when set. |
| goalAmount | number | Optional accumulate-to target amount. |
| paymentMode | string | account or creditCard when a funding account is linked. |
| creditCycleEndDay | number | Statement closing day (1–31) when present on credit-funded boxes. |
| accountLinkId | string | Id of the AccountLink funding this box, when linked. |
| isDeleted | boolean | Soft-delete flag when present on the stored document. |
| deletedAt | string | ISO-8601 soft-delete timestamp when present. |
| createdAt | string | Creation timestamp when present (API-created boxes). |
| updatedAt | string | Last update timestamp when present. |