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

Body

​
search
string
Free-text filter, matched case-insensitively as a substring of the campaign name or of its ObjectId.
​
status
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.
​
limit
integer
Page size, between 1 and 250. Defaults to 50.
​
offset
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

​
commission_letters_campaigns
object[]
​
next_offset
integer