Support

Help and documentation

API & webhooks

API documentation and examples

Overview

The reference for the Kyvento REST API is generated directly from the API source code. Until it is published, the endpoints are described in this article and in the articles linked here. This article gives you orientation on what the reference contains and how to reach your first successful request as quickly as possible.

What the reference contains

  • All public endpoints with parameters, validation rules and complete example responses – grouped by area (customers, subscriptions, invoices, payments, webhooks, …).
  • Example calls for each endpoint, ready to adopt directly.
  • Fundamentals chapters on authentication, webhook events and signatures, retry behavior and pagination.
  • The machine-readable OpenAPI 3 specification, which lets you import the entire API into tools like Postman or Insomnia, or generate client code for your programming language.

Your first request in three steps

  1. Create a token: Settings → "API Tokens" → "+ New token" (for the start, "Read only" is enough) – details in the article Setting up API access and creating an API key.
  2. Send a test call: for example, retrieve your own customer list:
    curl -H "Authorization: Bearer YOUR_TOKEN" https://app.kyvento.com/api/v1/customers
  3. Check the response: you receive JSON with a data array and a meta block for pagination.

API conventions

  • Versioning: all endpoints live under https://app.kyvento.com/api/v1/ – changes within a version stay backward-compatible and additive.
  • Response format: JSON; lists come as data + meta (page size, further pages, cursor).
  • Errors: meaningful HTTP status codes plus a machine-readable error_code in the body – build your error handling on the error_code, not on message texts.
  • Language: token responses are consistently in English – ideal for logging and stable evaluations.
  • Timestamps: timestamps in ISO 8601 format with a time-zone offset; pure calendar dates (such as the invoice date) as a date without a time.

Recommended getting-started path

  1. Get familiar with read endpoints (retrieving customers, subscriptions, invoices).
  2. Set up webhooks instead of searching for changes through constant polling – see Configuring webhooks.
  3. Only then tackle write operations – with the guidance from API rate limits and best practices.

Next steps