Up API

Tools (20)

Extracted live via the executor SDK.

• accounts.getAccounts

  Retrieve a paginated list of all accounts for the currently authenticated user. The returned list is paginated and can be scrolled by following the prev and next links where present.

• accounts.getAccountsId

  Retrieve a specific account by providing its unique identifier.

• categories.getCategories

  Retrieve a list of all categories and their ancestry. The returned list is not paginated.

• categories.getCategoriesId

  Retrieve a specific category by providing its unique identifier.

• categories.patchTransactionsTransactionIdRelationshipsCategory

  Updates the category associated with a transaction. Only transactions for which isCategorizable is set to true support this operation. The id is taken from the list exposed on /categories and cannot be one of the top-level (parent) categories. To de-categorize a transaction, set the entire data key to null. An HTTP 204 is returned on success. The associated category, along with its request URL is also exposed via the category relationship on the transaction resource returned from /transactions/{id}.

• tags.deleteTransactionsTransactionIdRelationshipsTags

  Disassociates one or more tags from a specific transaction. Tags that are not associated are silently ignored. An HTTP 204 is returned on success. The associated tags, along with this request URL, are also exposed via the tags relationship on the transaction resource returned from /transactions/{id}.

• tags.getTags

  Retrieve a list of all tags currently in use. The returned list is paginated and can be scrolled by following the next and prev links where present. Results are ordered lexicographically. The transactions relationship for each tag exposes a link to get the transactions with the given tag.

• tags.postTransactionsTransactionIdRelationshipsTags

  Associates one or more tags with a specific transaction. No more than 6 tags may be present on any single transaction. Duplicate tags are silently ignored. An HTTP 204 is returned on success. The associated tags, along with this request URL, are also exposed via the tags relationship on the transaction resource returned from /transactions/{id}.

• transactions.getAccountsAccountIdTransactions

  Retrieve a list of all transactions for a specific account. The returned list is paginated and can be scrolled by following the next and prev links where present. To narrow the results to a specific date range pass one or both of filter[since] and filter[until] in the query string. These filter parameters should not be used for pagination. Results are ordered newest first to oldest last.

• transactions.getTransactions

  Retrieve a list of all transactions across all accounts for the currently authenticated user. The returned list is paginated and can be scrolled by following the next and prev links where present. To narrow the results to a specific date range pass one or both of filter[since] and filter[until] in the query string. These filter parameters should not be used for pagination. Results are ordered newest first to oldest last.

• transactions.getTransactionsId

  Retrieve a specific transaction by providing its unique identifier.

• utilityEndpoints.getUtilPing

  Make a basic ping request to the API. This is useful to verify that authentication is functioning correctly. On authentication success an HTTP 200 status is returned. On failure an HTTP 401 error response is returned.

• webhooks.deleteWebhooksId

  Delete a specific webhook by providing its unique identifier. Once deleted, webhook events will no longer be sent to the configured URL.

• webhooks.getWebhooks

  Retrieve a list of configured webhooks. The returned list is paginated and can be scrolled by following the next and prev links where present. Results are ordered oldest first to newest last.

• webhooks.getWebhooksId

  Retrieve a specific webhook by providing its unique identifier.

• webhooks.getWebhooksWebhookIdLogs

  Retrieve a list of delivery logs for a webhook by providing its unique identifier. This is useful for analysis and debugging purposes. The returned list is paginated and can be scrolled by following the next and prev links where present. Results are ordered newest first to oldest last. Logs may be automatically purged after a period of time.

• webhooks.postWebhooks

  Create a new webhook with a given URL. The URL will receive webhook events as JSON-encoded POST requests. The URL must respond with a HTTP 200 status on success.

  There is currently a limit of 10 webhooks at any given time. Once this limit is reached, existing webhooks will need to be deleted before new webhooks can be created.

  Event delivery is retried with exponential backoff if the URL is unreachable or it does not respond with a 200 status. The response includes a secretKey attribute, which is used to sign requests sent to the webhook URL. It will not be returned from any other endpoints within the Up API. If the secretKey is lost, simply create a new webhook with the same URL, capture its secretKey and then delete the original webhook. See Handling webhook events for details on how to process webhook events.

  It is probably a good idea to test the webhook by sending it a PING event after creating it.

• webhooks.postWebhooksWebhookIdPing

  Send a PING event to a webhook by providing its unique identifier. This is useful for testing and debugging purposes. The event is delivered asynchronously and its data is returned in the response to this request.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools