Skip to content

Get compensation history​

GET
/v1/compensation/{membershipId}

Returns the compensation history for a single membership (one row per pay arrangement) ordered effective_from desc. Capability-gated — caller must carry the people.view_cost scope (or be owner/admin via cookie session). Amounts are returned as strings to preserve Decimal precision. Returns up to the 500 most recent entries (no pagination in v1).

Authorizations​

BearerAuth

API key in the form one_pk_<random>. Mint at /settings/api-keys.

Type
HTTP (bearer)

Parameters​

Path Parameters

membershipId*

The Membership.id whose compensation history to fetch.

Type
string
Required
Example"123"

Responses​

Array of compensation envelopes for the membership.

application/json
JSON
{
  
"meta": {
  
  
"version": 0,
  
  
"total": 0,
  
  
"membership_id": "string"
  
},
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"membership_id": "string",
  
  
  
"pay_type": "string",
  
  
  
"amount": "string",
  
  
  
"currency": "string",
  
  
  
"frequency": "string",
  
  
  
"engagement_type": "string",
  
  
  
"effective_from": "string",
  
  
  
"effective_to": "string",
  
  
  
"created_at": "string",
  
  
  
"updated_at": "string"
  
  
}
  
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

OneBusiness · Built for businesses that work.