Skip to main content
List the company’s commission-letter campaigns, most recently created first. A campaign is one batch of letters built from a template for a set of recipients. Each row is a summary with a derived overall_status and envelope_counts, with no per-recipient detail (see list_commission_letters).

​
Parameters

Body

​
string
Case-insensitive substring of the campaign name or id, the whole text taken as one phrase.
​
string
draft (not sent), generating (letters being generated), sent (sent by e-mail), awaiting_signatures (e-signature, letters still pending), completed (every letter signed), action_needed (a letter declined, voided or expired, even while others are pending). One of: draft, generating, sent, awaiting_signatures, completed, action_needed.
​
integer
Rows per page, 1 to 250. Default 50.
​
integer
Rows to skip. Omit it for the first page, never null or the string ‘None’; for the next page pass the previous next_offset.

​
Response

Body

​
object[]
​
integer