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

> List a commission-letter campaign's letters page by page, one row per recipient with envelope status, signers, pre/post signers and CC.

List the letters of one commission-letter campaign, one row per recipient.

The per-recipient side of `get_commission_letters_campaign`: each row carries
the letter's e-signature envelope (its status and when it reached it, the
ordered signers), the pre/post signers the campaign sets for that recipient and
the people in CC. Every person is surfaced by email, never a bare id. Rows
follow the campaign's recipient order. A campaign you can't access is reported
as not found.

## Parameters

<Accordion title="Body" defaultOpen>
  <ParamField body="campaign_id" type="string" required>
    Id of the campaign whose letters to list — the id
    list\_commission\_letters\_campaigns returns.
  </ParamField>

  <ParamField body="status" type="string">
    Keep only the letters in this signature state: awaiting\_signature (sent,
    waiting\_for\_approval, received or viewed: a signer still has to act),
    signed, or action\_needed (declined, voided or expired). A letter whose
    e-signature envelope is still being created counts as awaiting\_signature;
    one of a draft or e-mail campaign matches none. Omit for every letter. One
    of: `awaiting_signature`, `signed`, `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" type="object[]">
    <Expandable title="object properties">
      <ResponseField name="recipient" type="object">
        The user this letter is for.

        <Expandable title="object properties">
          <ResponseField name="id" type="string" />

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

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

      <ResponseField name="status" type="string">
        E-signature state of this letter: sent, waiting\_for\_approval, received,
        viewed, signed, declined, voided, expired. Null when the letter has no
        envelope yet: the campaign is still a draft, was sent by e-mail, or its
        e-signature envelope is still being created. One of: `sent`,
        `waiting_for_approval`, `received`, `viewed`, `signed`, `voided`,
        `expired`, `declined`.
      </ResponseField>

      <ResponseField name="status_at" type="string">
        When the envelope reached its current status.
      </ResponseField>

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

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

      <ResponseField name="cancelled_by" type="object">
        <Expandable title="object properties">
          <ResponseField name="id" type="string" />

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

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

      <ResponseField name="signers" type="object[]">
        The ordered signers of this letter's envelope; empty without an
        envelope.

        <Expandable title="object properties">
          <ResponseField name="user" type="object">
            <Expandable title="object properties">
              <ResponseField name="id" type="string" />

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

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

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

          <ResponseField name="status" type="string">
            Signer state: sent, received, delivered (means the letter was
            viewed), completed (signed), resent (reminder sent), declined. One
            of: `sent`, `received`, `delivered`, `completed`, `resent`,
            `declined`.
          </ResponseField>

          <ResponseField name="status_at" type="string">
            When this signer reached their current status.
          </ResponseField>
        </Expandable>
      </ResponseField>

      <ResponseField name="presigner" type="object">
        Who the campaign has sign this letter before its owner.

        <Expandable title="object properties">
          <ResponseField name="id" type="string" />

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

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

      <ResponseField name="postsigner" type="object">
        Who the campaign has sign this letter after its owner.

        <Expandable title="object properties">
          <ResponseField name="id" type="string" />

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

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

      <ResponseField name="cc_users" type="object[]">
        People in copy of this letter. For email they are copied when the letter
        is sent; for DocuSign they are notified after all signers complete. They
        do not sign.

        <Expandable title="object properties">
          <ResponseField name="id" type="string" />

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

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

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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.