Pocketsmith

PocketSmith

API version: 2.0

Auth

ApiKey X-Developer-Key in header | OAuth2

Base URL

https://api.pocketsmith.com/v2

Setup

1. Set your API key in the appropriate header
2. GET /me -- verify access
3. POST /users/{id}/institutions -- create first institutions

Endpoints

56 endpoints across 12 groups. See references/api-spec.lap for full details.

me

users

institutions

accounts

transaction_accounts

transactions

categories

events

scenarios

attachments

currencies

time_zones

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all me?" -> GET /me
• "Get user details?" -> GET /users/{id}
• "Update a user?" -> PUT /users/{id}
• "Get institution details?" -> GET /institutions/{id}
• "Update a institution?" -> PUT /institutions/{id}
• "Delete a institution?" -> DELETE /institutions/{id}
• "List all institutions?" -> GET /users/{id}/institutions
• "Create a institution?" -> POST /users/{id}/institutions
• "Get account details?" -> GET /accounts/{id}
• "Update a account?" -> PUT /accounts/{id}
• "Delete a account?" -> DELETE /accounts/{id}
• "List all accounts?" -> GET /users/{id}/accounts
• "Create a account?" -> POST /users/{id}/accounts
• "List all accounts?" -> GET /institutions/{id}/accounts
• "Get transaction_account details?" -> GET /transaction_accounts/{id}
• "Update a transaction_account?" -> PUT /transaction_accounts/{id}
• "List all transaction_accounts?" -> GET /users/{id}/transaction_accounts
• "Get transaction details?" -> GET /transactions/{id}
• "Update a transaction?" -> PUT /transactions/{id}
• "Delete a transaction?" -> DELETE /transactions/{id}
• "Search transactions?" -> GET /users/{id}/transactions
• "Search transactions?" -> GET /accounts/{id}/transactions
• "Search transactions?" -> GET /categories/{id}/transactions
• "Search transactions?" -> GET /transaction_accounts/{id}/transactions
• "Create a transaction?" -> POST /transaction_accounts/{id}/transactions
• "Get category details?" -> GET /categories/{id}
• "Update a category?" -> PUT /categories/{id}
• "Delete a category?" -> DELETE /categories/{id}
• "List all categories?" -> GET /users/{id}/categories
• "Create a category?" -> POST /users/{id}/categories
• "List all category_rules?" -> GET /users/{id}/category_rules
• "Create a category_rule?" -> POST /categories/{id}/category_rules
• "List all budget?" -> GET /users/{id}/budget
• "List all budget_summary?" -> GET /users/{id}/budget_summary
• "List all trend_analysis?" -> GET /users/{id}/trend_analysis
• "Get event details?" -> GET /events/{id}
• "Update a event?" -> PUT /events/{id}
• "Delete a event?" -> DELETE /events/{id}
• "List all events?" -> GET /users/{id}/events
• "List all events?" -> GET /scenarios/{id}/events
• "Create a event?" -> POST /scenarios/{id}/events
• "Get attachment details?" -> GET /attachments/{id}
• "Update a attachment?" -> PUT /attachments/{id}
• "Delete a attachment?" -> DELETE /attachments/{id}
• "List all attachments?" -> GET /users/{id}/attachments
• "Create a attachment?" -> POST /users/{id}/attachments
• "List all attachments?" -> GET /transactions/{id}/attachments
• "Create a attachment?" -> POST /transactions/{id}/attachments
• "Delete a attachment?" -> DELETE /transactions/{transaction_id}/attachments/{attachment_id}
• "List all labels?" -> GET /users/{id}/labels
• "List all saved_searches?" -> GET /users/{id}/saved_searches
• "List all currencies?" -> GET /currencies
• "Get currency details?" -> GET /currencies/{id}
• "List all time_zones?" -> GET /time_zones
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP