API reference

A REST API over JSON. Every path starts with /v2 and every request carries your API key.

TOLT_API_KEYGET /v2/partners Tolt

200 OK

responselist

successtrue

data[part_8fKq…]

has_moretrue

next_cursor

4xx or 5xx

error404

successfalse

code

doc_url

First request

Create a key in Dashboard → Settings → Integrations → Tolt API, then list your partners:

import { ToltApiClient } from "@tolt/api";

const tolt = new ToltApiClient({ token: process.env.TOLT_API_KEY! });
const { data } = await tolt.partners.list({ limit: 10 });

import os
from tolt import ToltApi

client = ToltApi(token=os.environ["TOLT_API_KEY"])
page = client.partners.list(limit=10)

curl "https://platform.tolt.com/v2/partners?limit=10" \
  -H "Authorization: Bearer $TOLT_API_KEY"

Response envelope

Every response wraps the result in data. Lists add pagination fields; errors set success: false and a code.

{
  "success": true,
  "message": "Success",
  "data": [
    {
      "id": "part_8fKq2LmZx7RtYw3nVbHc5dPj",
      "email": "sam@riverastudio.com",
      "first_name": "Sam",
      "last_name": "Rivera",
      "status": "active",
      "program_id": "prg_3hTq9WxLm2RbZk7VnYc4DsPf",
      "created_at": "2026-09-14T09:12:44.000Z"
    }
  ],
  "has_more": true,
  "next_cursor": "cur_WyIyMDI2LTA5LTE0VDA5OjEyOjQ0LjAwMFoiXQ",
  "prev_cursor": "cur_WyIyMDI2LTA5LTE0VDA5OjEyOjQ0LjAwMFoiXQ"
}

Conventions

Topic	Rule
Money	Integers in minor units. Send `4900` for $49.00; responses return it as the string `"4900"`
Timestamps	Responses use ISO 8601 in UTC. Request datetimes need an offset: `2026-01-01T00:00:00Z`
Updates	`PUT` is a partial update. Send only what changes; `null` clears a nullable field
Naming	`snake_case` everywhere. Unknown body fields are ignored
Request-Id	Every response has a `Request-Id` header. Send your own `Request-Id` to trace a call end to end

Promotion code value is the exception to the money rule: a string, as a percent for percentage codes and in major units for fixed codes ("20" = $20.00).

ID prefixes

Prefix	Resource	Prefix	Resource
`prg_`	Program	`clk_`	Click
`grp_`	Group	`cus_`	Customer
`part_`	Partner	`txn_`	Transaction
`lnk_`	Link	`comm_`	Commission
`promo_`	Promotion code	`flw_`	Flow

Records created before prefixed ids can still have plain ids. Treat every id as an opaque string.

Basics

Partners

Links

Clicks

Customers

Transactions

Commissions

Promotion codes

Reports

Embed

Programs

Groups

Flows

First request

Response envelope

Conventions

ID prefixes

​First request

​Response envelope

​Conventions

​ID prefixes

First request

Response envelope

Conventions

ID prefixes