Skip to main content
List compensation plans of your company, with filters and pagination. Each plan carries its section and its compensation count; open a plan with get_plan for each compensation’s design (scopes, variables, formulas) and the plan’s members. Rows are ordered alphabetically by plan name (A→Z).

​
Parameters

Body

​
string
Filter matched against the plan name (case-insensitive substring) or, when it is a valid ObjectId, against the plan id.
​
boolean
When True, return only archived plans; otherwise only live (non-archived) plans. Deleted plans are never returned.
​
string
Id of the sandbox to read instead of the live environment — the id list_sandboxes returns. Omit it to read the live environment, the company’s real compensation data, which is the right choice unless the question is explicitly about a sandbox. Only a sandbox id is accepted here — never a sandbox name, and never the live environment’s own id.
​
integer
Page size, between 1 and 250. Defaults to 50.
​
integer
Row offset into the result set — the number of rows to skip before this page. Any offset >= 0 is accepted; it does not have to be a multiple of limit, so you can start from an arbitrary row. Pass the next_offset returned by the previous call to walk the pages, or None for the first page.

​
Response

Body

​
object[]
​
integer