list_plans - Qobra public API documentation

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.

archived

boolean

When True, return only archived plans; otherwise only live (non-archived) plans. Deleted plans are never returned.

limit

integer

Page size, between 1 and 250. Defaults to 50.

offset

integer

Row offset into the result set — the number of rows to skip before this page. Pass the next_offset returned by the previous call, or None for the first page.

Response

Body

plans

object[]

Show object properties

string

resource_url

string

Deep link to open this plan in the Qobra web app.

name

string

archived

boolean

section

string

Folder/group this plan is filed under (a concept shared with reports); null if unfiled.

compensation_count

integer

How many compensations the plan holds. Open the plan with get_plan for each compensation’s design (scopes, variables, formulas) and the plan’s members.

next_offset

integer

list_quota_values get_plan

⌘I

​Parameters

​Response

Parameters

Response