The PocketSmith API
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.pocketsmith.com/v2
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
The PocketSmith API
| method | path | what the vendor says it does |
|---|---|---|
GET | /accounts/{id} | Get account Gets an account by its ID. Accounts |
PUT | /accounts/{id} | Update account Updates and returns an account by its ID. Accounts |
DELETE | /accounts/{id} | Delete account Deletes an account and all its data by ID, optionally merge scenarios into another account. Acc |
GET | /accounts/{id}/transactions | List transactions in account Lists transactions belonging to an account by its ID. Transactions |
GET | /attachments/{id} | Get attachment Gets a particular attachment by its ID. Attachments |
PUT | /attachments/{id} | Update attachment Updates the title of the attachment. Attachments |
DELETE | /attachments/{id} | Delete attachment Deletes a particular attachment by its ID. Attachments |
GET | /categories/{id} | Get category Gets a particular category by its ID. Categories |
PUT | /categories/{id} | Update category Updates a category by its ID. Categories |
DELETE | /categories/{id} | Delete category Deletes a particular category by its ID. This will delete all budgets within the category, and |
POST | /categories/{id}/category_rules | Create category rule in category Creates a rule to allocate a category to transactions. Category Rules |
GET | /categories/{id}/transactions | List transactions in categories Lists transactions belonging to one or more categories by their IDs. Transacti |
GET | /currencies | List currencies Lists currencies supported by PocketSmith. Currencies |
GET | /currencies/{id} | Get currency Gets a particular currency by its ID. Currencies |
GET | /events/{id} | Get event Gets a particular event by its ID. Events |
PUT | /events/{id} | Update event Updates an event by its ID. Events |
DELETE | /events/{id} | Delete event Deletes an event by its ID. Events |
GET | /institutions/{id} | Get institution Gets an institution by its ID. Institutions |
PUT | /institutions/{id} | Update institution Updates the title and currency code for an institution. Institutions |
DELETE | /institutions/{id} | Delete institution Deletes an institution and all data within. Alternatively, another institution can be provi |
GET | /institutions/{id}/accounts | List accounts in institution Lists accounts belonging to an institution by its ID. Accounts |
GET | /me | Get the authorised user Gets the user that corresponds to the access token used in the request. Users |
GET | /scenarios/{id}/events | List events in scenario. Lists events belonging to a scenario by their ID. Events |
POST | /scenarios/{id}/events | Create event in scenario Creates an event in a scenario by its ID. Events |
GET | /time_zones | List time zones Lists time zones. Time Zones |
GET | /transaction_accounts/{id} | Get transaction account Gets a transaction account by its ID. Transaction Accounts |
PUT | /transaction_accounts/{id} | Update transaction account Updates the transaction account by its ID. Transaction Accounts |
GET | /transaction_accounts/{id}/transactions | List transactions in transaction account Lists transactions belonging to a transaction account by its ID. Tran |
POST | /transaction_accounts/{id}/transactions | Create a transaction in transaction account Creates a transaction in a transaction account by its ID. Transact |
GET | /transactions/{id} | Get a transaction Gets a transaction by its ID. Transactions |
PUT | /transactions/{id} | Update a transaction Updates a transaction by its ID. Transactions |
DELETE | /transactions/{id} | Delete transaction Deletes a transaction and all its data by ID. Transactions |
GET | /transactions/{id}/attachments | List attachments in transaction Lists attachments belonging to a transaction by their ID. Attachments |
POST | /transactions/{id}/attachments | Assigns attachment to transaction Assigns an attachment to the transaction by their ID. Attachments |
DELETE | /transactions/{transaction_id}/attachments/{attachment_id} | Unassigns attachment in transaction Unassigns a particular attachment by its ID from the transaction ID. This |
GET | /users/{id} | Get user Gets a user by ID. You must be authorised as the target user in order to make this request. Users |
PUT | /users/{id} | Update user Updates the user by their ID. You must be authorised as the target user in order to make this requ |
GET | /users/{id}/accounts | List accounts in user Lists all accounts belonging to the user by their ID. Accounts |
POST | /users/{id}/accounts | Create an account in user Creates and returns an account belonging to the user by their ID. Accounts |
PUT | /users/{id}/accounts | Update the display order of accounts in user Updates the display order of accounts belonging to the user, by a |
and 16 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/pocketsmith/api/master/openapi.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.