Documentation
API v1
Thanks
Send peer recognition.
Working with an AI agent?or point it at the Thanks markdown or the full-API markdown.
Give Thanks
POST
/api/v1/thanks/giveGive thanks from one user to another. By default a token can only send thanks as its owner; a token with the 'thanks:impersonate' scope (admin-granted) may set fromEmail to any active member of the org.
| Parameter | Type | Description |
|---|---|---|
| fromEmail | string required | The email of the user giving thanks. By default this must match the token owner's email. To attribute thanks to someone else (e.g. an automated peer-bonus flow), the token needs the 'thanks:impersonate' scope, and the sender must be an active member of the org. The 'thanks:impersonate' scope can only be granted by an Administrator or Owner when creating the token. |
| toEmail | string required | The email of the user receiving thanks. |
| message | string required | The message of gratitude to deliver. |
Response:
{
message: string;
delivered: boolean;
url: string | null; // link to the delivered thanks (null if not delivered); viewing requires a signed-in session
from: {
email: string;
displayName: string;
manager: { email: string; displayName: string } | null; // direct manager
managerChain: { email: string; displayName: string; depth: number }[]; // upward chain (direct manager first)
};
to: {
email: string;
displayName: string;
manager: { email: string; displayName: string } | null;
managerChain: { email: string; displayName: string; depth: number }[];
};
}