Skip to main content
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

Body

string
required
Id of the campaign whose letters to list — the id list_commission_letters_campaigns returns.
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.
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. Pass the next_offset returned by the previous call, or None for the first page.

Response

Body

object[]
integer