> ## 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_commission_letters_campaigns

List your company's commission-letter campaigns as ready-to-judge summaries.

A campaign is one batch send of commission letters, built from a template for a
set of recipients. Each row is a summary — never per-recipient detail — carrying
everything needed to answer "where is this campaign?" without recomputing
anything: a derived `overall_status` and `envelope_counts` (letters tallied
per e-signature envelope status, already aggregated). Campaigns sent by e-mail
have no envelopes, so their `envelope_counts` is empty. Rows are ordered
most-recently-created first.

You see every campaign in the company.

## Parameters

<Accordion title="Body" defaultOpen>
  <ParamField body="search" type="string">
    Free-text filter, matched case-insensitively as a substring of the campaign
    name or of its ObjectId.
  </ParamField>

  <ParamField body="status" type="string">
    The campaign's overall status. One of draft (not sent), generating (letters
    still being generated), sent (sent by e-mail), awaiting\_signatures
    (e-signature, some letters still pending), completed (every letter signed)
    or action\_needed (at least one letter declined, voided or expired). One of:
    `draft`, `generating`, `sent`, `awaiting_signatures`, `completed`,
    `action_needed`.
  </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="commission_letters_campaigns" type="object[]">
    <Expandable title="object properties">
      <ResponseField name="id" type="string" />

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

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

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

      <ResponseField name="recipient_count" type="integer" />

      <ResponseField name="sending_choice" type="string">
        How the letters are delivered: email (plain email) or esignature
        (electronic signature). One of: `email`, `esignature`.
      </ResponseField>

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

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

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

      <ResponseField name="overall_status" type="string">
        One of: `draft`, `generating`, `sent`, `awaiting_signatures`,
        `completed`, `action_needed`.
      </ResponseField>

      <ResponseField name="envelope_counts" type="object">
        Letters tallied per e-signature envelope status; empty for e-mail
        campaigns (they have no envelopes).
      </ResponseField>
    </Expandable>
  </ResponseField>

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