> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qobra.co/llms.txt
> Use this file to discover all available pages before exploring further.

# list_plans

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

<Accordion title="Body" defaultOpen>
  <ParamField body="search" type="string">
    Filter matched against the plan name (case-insensitive substring) or, when
    it is a valid ObjectId, against the plan id.
  </ParamField>

  <ParamField body="archived" type="boolean">
    When True, return only archived plans; otherwise only live (non-archived)
    plans. Deleted plans are never returned.
  </ParamField>

  <ParamField body="limit" type="integer">
    Page size, between 1 and 250. Defaults to 50.
  </ParamField>

  <ParamField body="offset" type="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.
  </ParamField>
</Accordion>

## Response

<Accordion title="Body" defaultOpen>
  <ResponseField name="plans" type="object[]">
    <Expandable title="object properties">
      <ResponseField name="id" type="string" />

      <ResponseField name="resource_url" type="string">
        Deep link to open this plan in the Qobra web app.
      </ResponseField>

      <ResponseField name="name" type="string" />

      <ResponseField name="archived" type="boolean" />

      <ResponseField name="section" type="string">
        Folder/group this plan is filed under (a concept shared with reports);
        null if unfiled.
      </ResponseField>

      <ResponseField name="compensation_count" type="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.
      </ResponseField>
    </Expandable>
  </ResponseField>

  <ResponseField name="next_offset" type="integer" />
</Accordion>