API reference

Adoption

Alerts for live customers that stall: few employees signed in, activity dropped, or the numbers stopped coming.

Base URL https://partners.monotree.com/api/v1 · every call needs a token

List adoption alerts

get /adoption-alerts customers:read

An adoption alert says that a live customer stalls: few of the invited employees signed in, activity dropped, or its numbers stopped coming. Monotree checks every morning at 05:00 UTC; a customer has one open alert at most, and the alert is resolved when the customer recovers or is no longer live. Only the open alerts unless status says otherwise. The alert made last comes first. See Statistics and adoption.

Parameters

status

string · query

Open alerts, resolved ones, or all.

one of open, resolved, all · default open

seller

string · query

Only what belongs to this seller: their ID (sel_12), or external_ref: followed by your own reference for them (external_ref:usr_20503). The same on every list that takes seller. A seller that does not exist answers 404.

customer

string · query

Only the alerts of this customer, by ID or by external_ref: followed by your own reference. An unknown customer answers 404.

reason

string · query

Only alerts with this reason.

one of stale, activation, drop, inactive

limit

integer · query

How many to return in a page, 1 to 100.

default 25 · up to 100

cursor

string · query

The next_cursor of the page before, for the next page. Send the same filters with it.
Response · 200 A page of alerts.

object

string

has_more

boolean

Whether there is a page after this one.

next_cursor

string, nullable

Pass as cursor for the next page.

data

array of objects

Errors

400 invalid_cursor: the cursor is not one this API gave out.
401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks the ability this call needs.
404 not_found: no customer matches customer, or no seller matches seller.
422 validation_error: status, reason or limit has a value that is not allowed.
429 rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl https://partners.monotree.com/api/v1/adoption-alerts \
  -H "Authorization: Bearer $MONOTREE_TOKEN"
200 · Response
{
    "object": "list",
    "data": [
        {
            "id": "ala_01jd3m5p7r9t1v3x5z7b9d1f3h",
            "object": "adoption_alert",
            "customer": {
                "id": "cus_01jd0b2q4m6s8u0w2y4a6c8e0g",
                "company_name": "Librairie Voltaire",
                "external_ref": "org_51877"
            },
            "reason": "activation",
            "message": "Only 19% of invited employees have signed in, 126 days after going live",
            "advice": "Ask Louis Arnaud to invite the team again, or to share the company ID librairievoltaire at the next staff meeting.",
            "flagged_at": "2026-11-14T05:00:04Z",
            "resolved_at": null
        }
    ],
    "has_more": false,
    "next_cursor": null
}

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…

                    

Get an adoption alert

get /adoption-alerts/{alert} customers:read

One alert, open or resolved. While it is open, its reason and message follow the latest numbers.

Parameters

alert required

string · path

The alert's ID.
Response · 200 The alert.

id

string

object

string

customer

object

The customer that stalls.

id

string

company_name

string

external_ref

string, nullable

Your own reference for the customer.

reason

string

stale: no numbers for 3 days or more. activation: under 30% of the invited employees have registered. drop: the weekly active rate fell under half of what it was 4 weeks before. inactive: under 20% of the users were active in the last week. See Statistics and adoption for the exact rules.

one of stale, activation, drop, inactive

message

string

Why, in an English sentence with the numbers of the last check. It may be reworded; build on reason.

advice

string

What the seller can do about it, in an English sentence.

flagged_at

string

When the alert was first raised. It does not change when the alert is re-opened.

resolved_at

string, nullable

null while the alert is open.

Errors

401 invalid_token: the token is missing, revoked or expired.
403 insufficient_ability: the token lacks the ability this call needs.
404 not_found: no such adoption alert for your company and mode.
429 rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl https://partners.monotree.com/api/v1/adoption-alerts/ala_01jd3m5p7r9t1v3x5z7b9d1f3h \
  -H "Authorization: Bearer $MONOTREE_TOKEN"
200 · Response
{
    "id": "ala_01jd3m5p7r9t1v3x5z7b9d1f3h",
    "object": "adoption_alert",
    "customer": {
        "id": "cus_01jd0b2q4m6s8u0w2y4a6c8e0g",
        "company_name": "Librairie Voltaire",
        "external_ref": "org_51877"
    },
    "reason": "activation",
    "message": "Only 19% of invited employees have signed in, 126 days after going live",
    "advice": "Ask Louis Arnaud to invite the team again, or to share the company ID librairievoltaire at the next staff meeting.",
    "flagged_at": "2026-11-14T05:00:04Z",
    "resolved_at": null
}

Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.

Sending…