OAuth scopes

Choose the smallest complete set of permissions your application needs. This page is generated from the published @lunch-money/v2-api-spec/oauth-scopes catalog; do not edit it by hand.

Scopes are fixed when you create a client

Authorization requests omit scope. To change permissions later, create and review a replacement client, update your integration, and ask every user to authorize it.

Scope groups

Groups are selection shortcuts, not extra permissions. Every predefined group includes me:read so an application can identify the authorized Lunch Money user and budget account. A group expands to the exact scopes listed below.

Read only

View all supported Lunch Money data without changing it

me:read, summary:read, categories:read, crypto_manual:read, crypto_synced:read, balance_history:read, manual_accounts:read, plaid_accounts:read, transactions:read, transaction_attachments:read, tags:read, recurring_items:read, budgets:read

Transactions

Import, export, organize, and manage transactions and their attachments

me:read, transactions:read, transactions:create, transactions:update, transactions:delete, transaction_attachments:read, transaction_attachments:create, transaction_attachments:delete, categories:read, tags:read, manual_accounts:read, plaid_accounts:read, recurring_items:read

Budgeting

Analyze and manage budgets, categories, and tags

me:read, summary:read, budgets:read, budgets:update, budgets:delete, categories:read, categories:create, categories:update, categories:delete, tags:read, tags:create, tags:update, tags:delete, recurring_items:read

Accounts

Manage accounts, balances, and balance history

me:read, manual_accounts:read, manual_accounts:create, manual_accounts:update, manual_accounts:delete, plaid_accounts:read, plaid_accounts:update, crypto_manual:read, crypto_manual:create, crypto_manual:update, crypto_manual:delete, crypto_synced:read, crypto_synced:update, balance_history:read, balance_history:update, balance_history:delete

Organize

Manage categories and tags used to organize transactions

me:read, categories:read, categories:create, categories:update, categories:delete, tags:read, tags:create, tags:update, tags:delete, recurring_items:read

Full access

View and manage all supported Lunch Money data

me:read, me:update, summary:read, categories:read, categories:create, categories:update, categories:delete, crypto_manual:read, crypto_manual:create, crypto_manual:update, crypto_manual:delete, crypto_synced:read, crypto_synced:update, balance_history:read, balance_history:update, balance_history:delete, manual_accounts:read, manual_accounts:create, manual_accounts:update, manual_accounts:delete, plaid_accounts:read, plaid_accounts:update, transactions:read, transactions:create, transactions:update, transactions:delete, transaction_attachments:read, transaction_attachments:create, transaction_attachments:delete, tags:read, tags:create, tags:update, tags:delete, recurring_items:read, budgets:read, budgets:update, budgets:delete

Resource scopes

Scope	What it allows	V2 operations
`me:read`	View your Lunch Money identity and account, user, and budget settings	`getMe`, `getAccountSettings`, `getUserSettings`, `getUserAccountSettings`
`me:update`	Update your Lunch Money account, user, and budget settings	`updateAccountSettings`, `updateUserSettings`, `updateUserAccountSettings`
`summary:read`	View your budget summary	`getBudgetSummary`
`categories:read`	View categories and category groups	`getAllCategories`, `getCategoryById`
`categories:create`	Create categories and category groups	`createCategory`
`categories:update`	Update categories and category groups	`updateCategory`
`categories:delete`	Delete categories and category groups	`deleteCategory`
`crypto_manual:read`	View supported cryptocurrencies and manually managed cryptocurrency balances	`getAllCryptocurrencies`, `getAllCryptoManual`, `getCryptoManualById`
`crypto_manual:create`	Add supported cryptocurrencies and create manually managed cryptocurrency balances	`createCryptocurrency`, `createCryptoManual`
`crypto_manual:update`	Update manually managed cryptocurrency balances	`updateCryptoManual`
`crypto_manual:delete`	Delete manually managed cryptocurrency balances	`deleteCryptoManual`
`crypto_synced:read`	View synced cryptocurrency accounts and balances	`getAllCryptoSynced`, `getCryptoSyncedById`, `getCryptoSyncedBalanceBySymbol`
`crypto_synced:update`	Refresh balances for synced cryptocurrency accounts	`refreshCryptoSynced`
`balance_history:read`	View balance history for accounts and synced cryptocurrency balances	`getBalanceHistory`, `getBalanceHistoryForAccount`, `getBalanceHistoryForCryptoSynced`
`balance_history:update`	Create or update balance history and details for deleted accounts	`upsertBalanceHistoryForAccount`, `upsertBalanceHistoryForCryptoSynced`, `updateBalanceHistoryDetails`
`balance_history:delete`	Delete balance history for accounts and synced cryptocurrency balances	`deleteBalanceHistoryForAccount`, `deleteBalanceHistoryForCryptoSynced`, `deleteBalanceHistoryEntry`
`manual_accounts:read`	View manually managed accounts	`getAllManualAccounts`, `getManualAccountById`
`manual_accounts:create`	Create manually managed accounts	`createManualAccount`
`manual_accounts:update`	Update manually managed accounts	`updateManualAccount`
`manual_accounts:delete`	Delete manually managed accounts	`deleteManualAccount`
`plaid_accounts:read`	View accounts connected through Plaid	`getAllPlaidAccounts`, `getPlaidAccountById`
`plaid_accounts:update`	Request a Plaid account refresh, which may import new transactions	`triggerPlaidAccountFetch`
`transactions:read`	View transactions, including split and group information	`getAllTransactions`, `getTransactionById`
`transactions:create`	Create transactions	`createNewTransactions`
`transactions:update`	Update, split, unsplit, group, and ungroup transactions	`updateTransactions`, `updateTransaction`, `groupTransactions`, `ungroupTransactions`, `splitTransaction`, `unsplitTransaction`
`transactions:delete`	Delete transactions	`deleteTransactions`, `deleteTransactionById`
`transaction_attachments:read`	View transaction attachment metadata and get download access to attachments	`getTransactionAttachmentUrl`
`transaction_attachments:create`	Attach files to transactions	`attachFileToTransaction`
`transaction_attachments:delete`	Delete transaction attachments	`deleteTransactionAttachment`
`tags:read`	View tags	`getAllTags`, `getTagById`
`tags:create`	Create tags	`createTag`
`tags:update`	Update tags	`updateTag`
`tags:delete`	Delete tags	`deleteTag`
`recurring_items:read`	View recurring items	`getAllRecurring`, `getRecurringById`
`budgets:read`	View budget period settings	`getBudgetSettings`
`budgets:update`	Create or update budget amounts	`upsertBudget`
`budgets:delete`	Delete budget amounts	`deleteBudget`

Continued access

`offline_access`

Allow this app to maintain access without asking you to sign in and authorize it again

offline_access is not permission to a V2 resource. It allows an eligible token response to include a longer-lived, finite refresh token. Your application must still request every resource scope it needs when the client is created.

Find the scope for an endpoint

The V2 API reference displays the required OAuth scope for each operation. Scope requirements come from the same catalog and standard OpenAPI security metadata used to generate this page.

Next: Implement the authorization-code flow.