Skip to main content

Overview

Four endpoints describe who you are on Compago.

Your organization

These examples call the production host. While you build, replace https://api-harmony.compago.com with https://demo-api-harmony.compago.com and use a key from the Demo dashboard. See Environments.
This is the cheapest way to confirm a key works and to discover which organization it is bound to.
Your bank account and settlement details are not part of this response and are not readable through this API at all.

Members

Roles are owner, admin and member, oldest member first. The projection is deliberately narrow: name, email and role, and nothing else about the person.

Salespeople

Salespeople are the operators who sign in to your card terminals. Use this list to attribute sales to a person or to reconcile terminal activity against your staff roster.
Credentials are never returned. The password hash and the device token that signs an operator out everywhere are not even read from the database by this API.

Promotions

A promotion lets one organization absorb part of the fee on another’s payments, which is how a manufacturer funds months-without-interest on a retailer’s sales. The list returns both directions, and ownedByOrganization tells them apart:
  • true: your organization created and funds this promotion. The take is a cost to you.
  • false: your organization was invited and benefits. The discount reduces your fee.