Partner program

The Partner page, through the API. Invites and the overview answer for your own account only, and an id that is not yours answers 404. Setting client fees is under Partner fees.

#Invite a business

Emails a business your partner link, so a sign-up from it becomes your client. One invite email goes to an address every 7 days, and a day has an invite limit. A white label account with a live domain invites to its own sign-up page instead. Needs the signed Partner Terms.

Parameters

businessstring · required: The business name.
emailstring · required: Where to send the invite.
personstring: The name to greet. Left out, the email says "Hi there".
snapshotstring: The key of one of your Snapshots to start the business with. Left out, your link’s own Snapshot is used.
accessstring: none, account or agency: the access the invite asks for.

Errors

HTTP	Code	When
400	`snapshot_not_found`	That Snapshot is not in your account.
400		`business` is empty.
400	`link_installs_one`	Your link adds a snapshot to every new account. Change it on the Link tab to send without one.
409	`partner_is_sub_account`	`access: agency` from a sub-account’s key. Use your main account’s key.
429	`email_cooldown`	That address was invited in the last 7 days (`next_email_at` says when you can send again), or the daily limit is reached (no code).
500		Not sent. Retry.
503		Your partner link couldn’t be created just now. Nothing was sent. Retry in a minute.

curl -X POST "https://api.tryready.com/v1/partner/invites" \
  -H "X-API-Key: $READY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "business": "Client B Dental",
  "email": "owner@client-b.example.com",
  "person": "Dana"
}'

const res = await fetch('https://api.tryready.com/v1/partner/invites', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "business": "Client B Dental",
  "email": "owner@client-b.example.com",
  "person": "Dana"
}),
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.post(
    "https://api.tryready.com/v1/partner/invites",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    json={
  "business": "Client B Dental",
  "email": "owner@client-b.example.com",
  "person": "Dana"
},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "id": 501
  }
}

#List pending invites

Each address’s newest invite that has not signed up as one of your clients and was not cancelled, newest first, up to 500 addresses.

curl -X GET "https://api.tryready.com/v1/partner/invites" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/v1/partner/invites', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.READY_API_KEY },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.get(
    "https://api.tryready.com/v1/partner/invites",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "invites": [
      {
        "id": 501,
        "email": "owner@client-b.example.com",
        "business": "Client B Dental",
        "person": "Dana",
        "access": null,
        "sent_at": "2026-11-02 14:05:00",
        "sends": 1
      }
    ]
  }
}

#Cancel an invite

Cancels every open invite to that invite’s address. It leaves the pending list, and a sign-up at that address no longer opens the access request the invite asked for. Your partner link keeps working. You can’t undo it, and a new invite to that address waits until 7 days after the last invite email (429). An id that is not one of your invites answers 404.

Parameters

idinteger · path: The invite id from the list.

Errors

HTTP	Code	When
404	`invite_not_found`	No open invite with that id.

curl -X POST "https://api.tryready.com/v1/partner/invites/:id/cancel" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/v1/partner/invites/:id/cancel', {
  method: 'POST',
  headers: { 'X-API-Key': process.env.READY_API_KEY },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.post(
    "https://api.tryready.com/v1/partner/invites/:id/cancel",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "canceled": 1
  }
}

#Resend an invite

Emails the same invite again, under the same 7-day and daily limits as a new invite.

Parameters

idinteger · path: The invite id from the list.

Errors

HTTP	Code	When
404	`invite_not_found`	No open invite with that id.
429		That address was invited in the last 7 days.

curl -X POST "https://api.tryready.com/v1/partner/invites/:id/resend" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/v1/partner/invites/:id/resend', {
  method: 'POST',
  headers: { 'X-API-Key': process.env.READY_API_KEY },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.post(
    "https://api.tryready.com/v1/partner/invites/:id/resend",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "id": 502
  }
}

#Get the Partner overview

The Partner page in one read: you, your clients with their fees and status, the partners you recruited, and your daily earnings totals. The same figures the page shows. clients holds your newest 1,000 clients; clients_cut is true when older ones are left out. daily holds up to 200,000 rows, newest day first; past that, ledger_from is the first day it covers, else null. Answers 404 while the partner program is off for the account.

Errors

HTTP	Code	When
404		The partner program is off for this account.

curl -X GET "https://api.tryready.com/v1/partner/overview" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/v1/partner/overview', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.READY_API_KEY },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.get(
    "https://api.tryready.com/v1/partner/overview",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "partner": {
      "id": 42,
      "business": "Acme Texting",
      "name": "Sam Lee",
      "since": "2026-03-01"
    },
    "clients": [],
    "clients_cut": false,
    "partners": [],
    "ledger_from": null,
    "daily": []
  }
}

#List your clients

The clients table of the Sub-accounts page: your sub-accounts with what they sent, replies, spend and registration, for the last days days. Only your own clients. Search with q by name, email, id or number.

Parameters

daysinteger · query: The window in days. Default 30, at most 90. A value that is not a whole number above 0 uses 30, and a larger one uses 90.
qstring · query: Search text.

Errors

HTTP	Code	When
403	`not_agency_owner`	The account is not an agency or the key acts as a sub-account.

curl -X GET "https://api.tryready.com/v1/partner/clients" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/v1/partner/clients', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.READY_API_KEY },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.get(
    "https://api.tryready.com/v1/partner/clients",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "rows": [],
    "totals": {}
  }
}