API reference

The Kustomer REST API

447 operations across 10 APIs. Every page has the full request and response schema, examples, samples in five languages and a live console.

Base URL
https://{orgname}.api.kustomerapp.com
Auth
Authorization: Bearer <API key>
Format
JSON in, JSON:API-style envelopes out
Rate limits
Per org, per minute, by plan. Watch x-ratelimit-*
Your first request
curl https://acme.api.kustomerapp.com/v1/customers?pageSize=2 \
  --header "Authorization: Bearer $KUSTOMER_API_KEY"
Open the API consoleSearch all 447 endpoints, fill parameters, send live requests in tabs and copy any request as cURL, JavaScript, Python or kusty.Download the Postman collectionAll 447 requests, grouped by API, with examples and required roles. After importing, set orgName and apiKey in the collection variables.

Core data

Core resources171 ops

Customers, companies, conversations, messages, notes, drafts, KObjects, Klasses, search, bulk operations and more.

base path /v1

Core resources v21 ops

Newer v2 endpoints for core CRM data, starting with conversation times.

base path /v2

Conversations and routing

Queues and routing37 ops

Queues, queue rules, routing statuses, team routing settings, work sessions, work items and live metrics.

base path /v1

Chat conversations10 ops

Server-side chat sessions, messages and handoff with an API token (v2.1).

base path /v2.1

Knowledge

Knowledge base71 ops

Knowledge bases, articles, categories, versions and languages, forms, themes, templates, routes and custom domains.

paths include version

Platform

Workflows10 ops

Create and update workflows, manage workflow variables and inspect process errors.

base path /v1

Apps platform40 ops

Apps, cards, KViews, inbound email/form/web hooks and outbound webhooks with their transactions.

base path /v1

Settings and configurations55 ops

Chat settings, notifications, search filters, shortcuts, snippets, satisfaction surveys, snoozes and user settings.

base path /v1

Access management33 ops

Users, teams, role groups, auth tokens (API keys) and authentication settings.

base path /v1

AI

AI and automations19 ops

AI automations, evaluations with test cases and runs, and conversation summaries.

base path /v1