# PocketSmith Documentation

> Guides, documentation and reference material for PocketSmith's API.

Append .md to any documentation page URL to get its markdown version.

## Guides
- [Pagination](https://developers.pocketsmith.com/docs/pagination.md)
- [MCP Server](https://developers.pocketsmith.com/docs/pocketsmith-mcp-server.md): Connect your PocketSmith account to any AI assistant that supports the Model Context Protocol.

## API Reference
- [Get the authorised user](https://developers.pocketsmith.com/reference/get_me-1.md): Gets the user that corresponds to the access token used in the request.
- [Get user](https://developers.pocketsmith.com/reference/get_users-id-1.md): Gets a user by ID. You must be authorised as the target user in order to make this request.
- [Update user](https://developers.pocketsmith.com/reference/put_users-id-1.md): Updates the user by their ID. You must be authorised as the target user in order to make this request.
- [Get institution](https://developers.pocketsmith.com/reference/get_institutions-id-1.md): Gets an institution by its ID.
- [Update institution](https://developers.pocketsmith.com/reference/put_institutions-id-1.md): Updates the title and currency code for an institution.
- [Delete institution](https://developers.pocketsmith.com/reference/delete_institutions-id-1.md): Deletes an institution and all data within. Alternatively, another institution can be provided to merge the data into to avoid losing it.
- [List institutions in user](https://developers.pocketsmith.com/reference/get_users-id-institutions-1.md): Lists all the institutions belonging to the user.
- [Create institution in user](https://developers.pocketsmith.com/reference/post_users-id-institutions-1.md): Creates an institution belonging to a user.
- [Get account](https://developers.pocketsmith.com/reference/get_accounts-id-1.md): Gets an account by its ID.
- [Update account](https://developers.pocketsmith.com/reference/put_accounts-id-1.md): Updates and returns an account by its ID.
- [Delete account](https://developers.pocketsmith.com/reference/delete_accounts-id-1.md): Deletes an account and all its data by ID, optionally merge scenarios into another account.
- [List accounts in user](https://developers.pocketsmith.com/reference/get_users-id-accounts-1.md): Lists all accounts belonging to the user by their ID.
- [Update the display order of accounts in user](https://developers.pocketsmith.com/reference/put_users-id-accounts-1.md): Updates the display order of accounts belonging to the user, by accepting an array of accounts in their new display order.
- [Create an account in user](https://developers.pocketsmith.com/reference/post_users-id-accounts-1.md): Creates and returns an account belonging to the user by their ID.
- [List accounts in institution](https://developers.pocketsmith.com/reference/get_institutions-id-accounts-1.md): Lists accounts belonging to an institution by its ID.
- [Get transaction account](https://developers.pocketsmith.com/reference/get_transaction-accounts-id-1.md): Gets a transaction account by its ID.
- [Update transaction account](https://developers.pocketsmith.com/reference/put_transaction-accounts-id-1.md): Updates the transaction account by its ID.
- [List transaction accounts in user](https://developers.pocketsmith.com/reference/get_users-id-transaction-accounts-1.md): List all transaction accounts belonging to a user.
- [Get a transaction](https://developers.pocketsmith.com/reference/get_transactions-id-1.md): Gets a transaction by its ID.
- [Update a transaction](https://developers.pocketsmith.com/reference/put_transactions-id-1.md): Updates a transaction by its ID.
- [Delete transaction](https://developers.pocketsmith.com/reference/delete_transactions-id.md): Deletes a transaction and all its data by ID.
- [List transactions in user](https://developers.pocketsmith.com/reference/get_users-id-transactions-1.md): Lists transactions belonging to a user by their ID.
- [List transactions in account](https://developers.pocketsmith.com/reference/get_accounts-id-transactions-1.md): Lists transactions belonging to an account by its ID.
- [List transactions in categories](https://developers.pocketsmith.com/reference/get_categories-id-transactions.md): Lists transactions belonging to one or more categories by their IDs.
- [List transactions in transaction account](https://developers.pocketsmith.com/reference/get_transaction-accounts-id-transactions-1.md): Lists transactions belonging to a transaction account by its ID.
- [Create a transaction in transaction account](https://developers.pocketsmith.com/reference/post_transaction-accounts-id-transactions-1.md): Creates a transaction in a transaction account by its ID.
- [Get category](https://developers.pocketsmith.com/reference/get_categories-id-1.md): Gets a particular category by its ID.
- [Update category](https://developers.pocketsmith.com/reference/put_categories-id-1.md): Updates a category by its ID.
- [Delete category](https://developers.pocketsmith.com/reference/delete_categories-id-1.md): Deletes a particular category by its ID. This will delete all budgets within the category, and uncategorize all transactions assigned to the category.
- [List categories in user](https://developers.pocketsmith.com/reference/get_users-id-categories-1.md): Lists all categories belonging to a user by their ID.
- [Create category in user](https://developers.pocketsmith.com/reference/post_users-id-categories-1.md): Creates a category belonging to the user by their ID.
- [List category rules in user](https://developers.pocketsmith.com/reference/get_users-id-category-rules-1.md): Lists all category rules belonging to a user by their ID.
- [Create category rule in category](https://developers.pocketsmith.com/reference/post_categories-id-category-rules-1.md): Creates a rule to allocate a category to transactions.
- [List budget for user](https://developers.pocketsmith.com/reference/get_users-id-budget-1.md): Lists the user's budget, consisting of one or more budget analysis packages, one per category. Akin to the list on the Budget page in PocketSmith.
- [Get budget summary for user](https://developers.pocketsmith.com/reference/get_users-id-budget-summary-1.md): Get the user's budget summary, containing an expense and income analysis for all categories (excluding transfer categories) for the given period and date range. Akin to the overall budget shown on the Budget page in PocketSmith.
- [Get trend analysis for user](https://developers.pocketsmith.com/reference/get_users-id-trend-analysis-1.md): Get an income and/or expense budget analysis for the given date range and period across any number of categories and scenarios. Akin to the Trends page in PocketSmith.
- [Delete forecast cache for user](https://developers.pocketsmith.com/reference/delete_users-id-forecast-cache.md): Delete the user's cached forecast by recalculating the forecast.
- [Get event](https://developers.pocketsmith.com/reference/get_events-id.md): Gets a particular event by its ID.
- [Update event](https://developers.pocketsmith.com/reference/put_events-id.md): Updates an event by its ID.
- [Delete event](https://developers.pocketsmith.com/reference/delete_events-id.md): Deletes an event by its ID.
- [List events in user.](https://developers.pocketsmith.com/reference/get_users-id-events.md): Lists events belonging to a user by their ID.
- [List events in scenario.](https://developers.pocketsmith.com/reference/get_scenarios-id-events.md): Lists events belonging to a scenario by their ID.
- [Create event in scenario](https://developers.pocketsmith.com/reference/post_scenarios-id-events.md): Creates an event in a scenario by its ID.
- [Get attachment](https://developers.pocketsmith.com/reference/get_attachments-id-1.md): Gets a particular attachment by its ID.
- [Update attachment](https://developers.pocketsmith.com/reference/put_attachments-id-1.md): Updates the title of the attachment.
- [Delete attachment](https://developers.pocketsmith.com/reference/delete_attachments-id-1.md): Deletes a particular attachment by its ID.
- [Lists attachments in user](https://developers.pocketsmith.com/reference/get_users-id-attachments-1.md): Lists attachments belonging to a user by their ID.
- [Create attachment in user](https://developers.pocketsmith.com/reference/post_users-id-attachments-1.md): Creates an attachment belonging to the user by their ID.
- [List attachments in transaction](https://developers.pocketsmith.com/reference/get_transactions-id-attachments-1.md): Lists attachments belonging to a transaction by their ID.
- [Assigns attachment to transaction](https://developers.pocketsmith.com/reference/post_transactions-id-attachments-1.md): Assigns an attachment to the transaction by their ID.
- [Unassigns attachment in transaction](https://developers.pocketsmith.com/reference/delete_transactions-transaction-id-attachments-attachment-id-1.md): Unassigns a particular attachment by its ID from the transaction ID. This does not delete the attachment, it only removes its association from the transaction.
- [List labels in user](https://developers.pocketsmith.com/reference/get_users-id-labels.md): Lists labels belonging to a user by their ID.
- [List saved searches in user](https://developers.pocketsmith.com/reference/get_users-id-saved-searches.md): Lists saved searches belonging to a user by their ID.
- [List currencies](https://developers.pocketsmith.com/reference/get_currencies.md): Lists currencies supported by PocketSmith.
- [Get currency](https://developers.pocketsmith.com/reference/get_currencies-id.md): Gets a particular currency by its ID.
- [List time zones](https://developers.pocketsmith.com/reference/get_time-zones.md): Lists time zones.

## Changelog
- [Welcome to the new PocketSmith developer hub](https://developers.pocketsmith.com/changelog/welcome-to-pocketsmith.md)