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

Kintsugi Customers API

Customer records and their transactions.

Kintsugi Customers API is one of 9 APIs that Kintsugi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 5 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.trykintsugi.com/v1.

5 operations 3 paths 6 schemas 3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.trykintsugi.com/v1
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Kintsugi Customers API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). An API key is passed in the header as x-organization-id (OrganizationId). By default, every request must be authenticated.

  • ApiKeyAuth — API key generated in the Kintsugi dashboard.
  • OrganizationId — Identifier of the organization the request acts on behalf of.

Paths & Operations 5

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

Customers 5

Customer records and their transactions.

POST
/customers
Create a customer.
createCustomer body → 201
GET
/customers
List customers.
getCustomers 2 params → 200
GET
/customers/{id}
Get a customer by ID.
getCustomerById 1 param → 200404
PATCH
/customers/{id}
Update a customer.
updateCustomer 1 param body → 200
GET
/customers/external/{external_id}
Get a customer by external ID.
getCustomerByExternalId 1 param → 200404

Schemas 6

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

Address
object
9 properties 2 required
CustomerPage
Customer
CustomerRequest
object
4 properties
Page
object
5 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kintsugi-customers-api-openapi.yml Raw ↑

Other APIs Kintsugi publishes across the network.

Kintsugi Address Validation API
Kintsugi Exemptions API
Kintsugi Filings API
Kintsugi Nexus API
Kintsugi Products API
Kintsugi Registrations API
Kintsugi Tax Estimation API
Kintsugi Transactions API