Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Increase Events API

Events and webhook Event Subscriptions.

Increase Events API is one of 16 APIs that Increase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Events. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 2 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.

6 operations 4 paths 2 schemas 4 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.increase.com
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Increase Events API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Increase API key passed as Authorization: Bearer YOURAPIKEY. Keys are environment-scoped (production vs sandbox). OAuth is also supported for platform / Increa…

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 4 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Events 6

Events and webhook Event Subscriptions.

GET
/events
List Events
listEvents 3 params → 200
GET
/events/{event_id}
Retrieve an Event
retrieveEvent 1 param → 200
GET
/event_subscriptions
List Event Subscriptions
listEventSubscriptions → 200
POST
/event_subscriptions
Create an Event Subscription
createEventSubscription body → 200
GET
/event_subscriptions/{event_subscription_id}
Retrieve an Event Subscription
retrieveEventSubscription 1 param → 200
PATCH
/event_subscriptions/{event_subscription_id}
Update an Event Subscription
updateEventSubscription 1 param body → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Event (6 properties), EventSubscription (5 properties). Each schema is shown below with its type and property counts.

EventSubscription
object
5 properties
Event
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

increase-com-events-api-openapi.yml Raw ↑

Other APIs Increase publishes across the network.

Increase Account Numbers API
Increase Accounts API
Increase ACH Transfers API
Increase Bookkeeping API
Increase Card Payments API
Increase Card Profiles API
Increase Cards API
Increase Check Transfers API
Increase Entities API
Increase External Accounts API
Increase Lockboxes API
Increase Real-Time Payments API