API Documentation

REST API reference for integrating with the platform programmatically.

Overview

Authentication

Authenticate API requests using bearer tokens and API keys.

REST API

GET /api/v1/users

List users

Returns a paginated list of users in the organization.

Returns a paginated list of users in the organization. Refer to the authentication guide for required headers.

Request example

curl -H "Authorization: Bearer $TOKEN" https://api.example.com/api/v1/users

Response example

{"data": [], "meta": {"page": 1, "total": 0}}
POST /api/v1/users

Create user

Creates a new user account.

Creates a new user account. Refer to the authentication guide for required headers.

Request example

curl -H "Authorization: Bearer $TOKEN" https://api.example.com/api/v1/users

Response example

{"data": [], "meta": {"page": 1, "total": 0}}
GET /api/v1/subscriptions/{id}

Get subscription

Retrieves subscription details by ID.

Retrieves subscription details by ID. Refer to the authentication guide for required headers.

Request example

curl -H "Authorization: Bearer $TOKEN" https://api.example.com/api/v1/subscriptions/123

Response example

{"data": [], "meta": {"page": 1, "total": 0}}
GET /api/v1/invoices

List invoices

Returns billing invoices for the authenticated account.

Returns billing invoices for the authenticated account. Refer to the authentication guide for required headers.

Request example

curl -H "Authorization: Bearer $TOKEN" https://api.example.com/api/v1/invoices

Response example

{"data": [], "meta": {"page": 1, "total": 0}}