Skip to main content

Get the caller's own earnings-goal progress for the current period

GET 
/organizations/earnings/goal/:organization

Returns the caller's own earnings so far in the current period (today/this week/this month, depending on their goal's period), their effective goal (a manager/owner override on their membership, falling back to their own settings.earnings.goal), and whether they've chosen to show the earnings widget in the sidebar. periodKey identifies the current period (e.g. 2026-10-19, 2026-10-13 for the Monday starting that week, or 2026-10) so callers can detect when a new period starts. periodEnd is the ISO instant the period ends (local end-of-day/week/month), for showing a countdown. breakdown is how earned splits across pay types for this same period.

Request​

Responses​

Default Response