Increase Exports API
Exports are generated files. Some exports can contain a lot of data, like a CSV of your transactions. Others can be a single document, like a tax form. Since they can take a while, they are generated asynchronously. We send a webhook when they are ready. For more information, please read our [Exports documentation](https://increase.com/documentation/exports).
Increase Exports API is one of 56 APIs that Increase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Exports. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 3 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.
Requests are made against 2 base URLs: https://api.increase.com, https://sandbox.increase.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Increase Exports API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 3
Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Exports are generated files. Some exports can contain a lot of data, like a CSV of your transactions. Others can be a single document, like a tax form. Since they can take a while…
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are export (22 properties), create_an_export_parameters (11 properties), export_list (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Increase 12
Other APIs Increase publishes across the network.