Introduction

Monotree Partners API

Sign up companies to Monotree, follow them to live and look after them from your own system.

Get started

Quickstart

A sandbox token to a live test customer in five calls.

Reference

API reference

Every endpoint, its fields and a call to try.

Webhooks

Events

Hear when a customer goes live, signed by Monotree.

You are a Monotree partner: you sell Monotree, the app for a company's employees, to your own customers. This API lets your system do that work without anyone opening the Partners portal. A seller can sign up a customer in the portal, your back office can do it with one POST, or you can mix the two: both end up in the same list, credited to the same sellers and counted in the same monthly statement.

A few words used throughout:

Word Means
Partner Your company. An API token belongs to it.
Customer A company you signed up to Monotree, such as Boulangerie Martin.
Company ID The customer's address and what its employees type in the Monotree app: boulangeriemartin.
Admin The person at the customer who runs its Monotree. They get the invitation.
Seller A person at your company who signs up customers. Every customer is credited to one.
Sandbox A test copy of your account. Calls with a sandbox token set nothing up for real.

What you can do

Sign up customers Create a company with its admin, languages, logo and colours. It is live in about a minute, and its admin gets an invitation by email.
Follow them to live Read the step a customer is on, or let a webhook tell you when it is live.
Change them Rename, add languages, swap the logo or change the admin. Changes reach the customer's app within a minute.
Suspend, resume, cancel Pause access when a customer stops paying you, give it back when they pay, or cancel for good.
Credit your sellers Every customer belongs to the seller who signed it, by your own ID for that seller.
See how customers do Each customer's usage, alerts for the ones that stall, and your month as Monotree counts it for the statement.
Answer support Read and answer what your customers' employees ask, from your own helpdesk.

Run everything from your own system walks through all of it, and lists the few things that still need the portal.

How it fits together

  1. You call https://partners.monotree.com/api/v1 with an API token. An admin creates the first one under Developers in the portal.
  2. The API checks the request, stores the customer and records who did it.
  3. Monotree sets the company up on its own platform, step by step.
  4. Your webhook endpoint hears about every change, signed so you know it came from Monotree.

You never deal with servers, installs or app builds. A customer's employees use the Monotree app from the App Store or Google Play and type the company ID to get in.

Where to start

Conventions in short

  • JSON in, JSON out, UTF-8. Times are ISO 8601 in UTC (2026-11-12T09:41:00Z). Messages are in English.
  • The base URL is https://partners.monotree.com/api/v1 for live and sandbox alike. The token decides which.
  • Errors have one shape with a stable type to act on. See Errors.
  • Creating a customer needs an Idempotency-Key header, so a retry never makes a second one.
  • Lists are paginated with a cursor, newest first.
  • A query parameter a call does not take answers 422 and names it, so a typo in a filter never gives you the whole list. In a JSON body, fields we do not know are ignored.
  • You may make 120 requests a minute, counted per partner and mode (live or sandbox), not per token.

IDs

Every object has an id with a prefix that says what it is. Treat IDs as opaque strings.

Prefix Object
prt_ Your company (the partner)
cus_ A customer
sel_ A seller
evt_ An event
whe_ A webhook endpoint
whd_ A delivery of an event to a webhook endpoint
tok_ An API token
ala_ An adoption alert
sev_ A line of the sign-in log
sth_ A support thread
msg_ A message in a support thread
esc_ A support escalation

The support guide lists the IDs of the smaller support objects. For a customer and a seller you can also use your own reference in place of the ID: see Your own reference.