Skip to main content
GET
Read the member's Exigo figures

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a portal JWT whose login is linked to a membership in that company, or an opaque member token. The credential alone identifies the member and company. A member session JWT, the kind order and subscription email links carry, is refused with 403. A company admin's own credential is not a member credential and gets 401.

Path Parameters

operation
enum<string>
required

The operation to read.

Available options:
summary,
team,
earnings,
plan,
activity

Query Parameters

period
string

Month to read, as YYYY-MM. Defaults to the current month in the company's Exigo timezone. Accepted only for summary, team and earnings; plan accepts no query parameters.

Pattern: ^\d{4}-(0[1-9]|1[0-2])$
Example:

"2026-10"

page
string

Page of the team list, 25 per page, from 1 to 1000. Accepted for team. On the member's own earnings it pages both the ledger and the payouts, an older form kept for existing clients; use ledger_page and payouts_page instead.

Pattern: ^([1-9]\d{0,2}|1000)$
Example:

"2"

type
enum<string>

Limit the team list to affiliates or customers. Accepted only for team.

Available options:
affiliate,
customer
ledger_page
string

Page of the earnings commission ledger, 25 per page, from 1 to 1000. Accepted only for the member's own earnings.

Pattern: ^([1-9]\d{0,2}|1000)$
Example:

"2"

payouts_page
string

Page of the earnings payouts, 25 per page, from 1 to 1000. Accepted only for the member's own earnings.

Pattern: ^([1-9]\d{0,2}|1000)$
Example:

"2"

of
string

Exigo customer id of someone in the member's team to read instead of the member. Use the team/{exigo_id}/{operation} path instead. Accepted only for summary, team and activity, with the same checks as the path; the member's own id reads as if it were not sent.

Pattern: ^[1-9]\d{0,9}$
Example:

"4388"

Response

The figures. Their shape follows the operation.

The envelope every Exigo answer is in, with or without figures.

status
integer
required

HTTP status code (mirrors the response status line).

exigo
object
required

One operation's answer, with how fresh it is.

meta
object
required

Envelope metadata present on every response.