Walletguide
DevelopersAPIReferencewallets

Retrieve wallet

Returns the wallet the caller has access to.

GET
/wallets/{walletId}

Authorization

bearerAuth
headerAuthorization<token>

A Walletguide API key (wg_…) or an OAuth bearer token. Paste the value only. Create a key under Wallet settings → API keys.

Path Parameters

walletId*string

The wallet row uuid

Formatuuid

Response Body

The wallet

application/json
  1. response
id*string
Formatuuid
name*string
baseCurrency*string
active*boolean
planSettings*|null
imagePath*|

Path of the image uploaded in the wallet settings, relative to the public assets host (https://assets.walletguide.com). Null when the wallet shows its default icon.

lastOverallUpdatedTime*|
Formatdate-time
Example Request
curl -X GET 'https://api.walletguide.com/wallets/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "baseCurrency": "string",  "active": true,  "planSettings": {    "levels": [      "string"    ],    "showPercentageForPastMonths": true  },  "imagePath": "string",  "lastOverallUpdatedTime": "2019-08-24T14:15:22Z"}

Create wallet

Create a wallet for the person you act for, with them as its owner, as they would in the app: with the default categories, and on their plan.

Update wallet

Renaming the wallet or changing its base currency needs wallet:manage, which only the owner holds: in a signed-in session, through an API key whose…