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

Kanmon Users API

The Users API from Kanmon — 3 operation(s) for users.

Kanmon Users API is one of 14 APIs that Kanmon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 3 paths, and defines 19 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

Requests are made against 4 base URLs: https://api.kanmon.com, https://api.kanmon.dev, http://localhost:3333, https://workflow.concar.dev.

5 operations 3 paths 19 schemas 2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Base URL
https://api.kanmon.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Kanmon Users API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization).

Paths & Operations 5

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

Users 5
GET
/api/platform/v2/users
Fetch users
getAllUsers 9 params → 200400403429500
POST
/api/platform/v2/users
Create a user
createUser body → 201400403404409429500
GET
/api/platform/v2/users/{id}
Fetch a user
getUser 2 params → 200400403404429500
PATCH
/api/platform/v2/users/{id}
Update a user
updateUser 2 params body → 200400403404409429500
POST
/api/platform/v2/users/merge
Merge users from a source business into a target business
mergeUserIntoBusiness body → 200400403404409429500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are User (14 properties), CreateUserRequestBody (11 properties), UpdateUserRequestBody (7 properties), Address (6 properties). Each schema is shown below with its type and property counts.

UpdateUserRequestBody
object
7 properties
MergeUsersResponseBody
object
1 property 1 required
UserNotFoundException
object
3 properties 3 required
UserAlreadyExistsWithPlatformUserIdException
object
3 properties 3 required
PaginationResult
object
3 properties 3 required
BusinessNotFoundException
object
3 properties 3 required
updateUser_409_response
InternalServerErrorException
object
3 properties 3 required
Address
object
6 properties 5 required
PrimaryBusinessOwnerAlreadyExistsForBusinessException
object
3 properties 3 required
User
object
14 properties 7 required
ForbiddenException
object
3 properties 3 required
GetUsersResponse
object
2 properties 2 required
BadRequestException
object
3 properties 3 required
MergeUsersRequestBody
object
4 properties
UserAlreadyExistsWithEmailException
object
3 properties 3 required
createUser_409_response
TooManyRequestsException
object
3 properties 3 required
CreateUserRequestBody
object
11 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kanmon-users-api-openapi.yml Raw ↑

Other APIs Kanmon publishes across the network.

Kanmon Bank Accounts API
Kanmon Businesses API
Kanmon Connect Tokens API
Kanmon Documents API
Kanmon Draw Requests API
Kanmon Embedded Sessions API
Kanmon Integrated MCA API
Kanmon Invoices API
Kanmon Issued Products API
Kanmon Offers API
Kanmon Payments API
Kanmon Prequalifications API