list_commission_letters: take a campaign row and
read everything about it — its meta (template, subject, send choice, when and by
whom it was sent, a derived overall_status), one EnvelopeDetail per
recipient (status plus sent / received / viewed / signed / declined / voided /
expired timestamps, and the ordered signers of that letter), and the campaign’s
pre/post signers per user. Every person is surfaced as a structured {id, email, name} user reference, never a bare id. A single object — no pagination. A
campaign you can’t access is reported as not found. The letters’ PDF content is
omitted.
Parameters
Body
Body
string
required
The campaign to read. Accepts the campaign’s ObjectId (the id returned by
list_commission_letters) or a case-insensitive substring of its name. A name
matching no — or more than one — campaign raises a clear error; pass the
full id to disambiguate.
Response
Body
Body
string
string
Deep link to open this campaign in the Qobra web app.
string
string
integer
string
How the letters are delivered: email (plain email) or esignature (electronic
signature). One of:
email, esignature.boolean
string
string
string
One of:
draft, generating, sent, awaiting_signatures, completed,
action_needed.object
Letters tallied per e-signature envelope status; empty for e-mail campaigns
(they have no envelopes).
string
object
string
How the pre-signer is chosen: specific (a fixed named person) or dynamic
(resolved from the org chart, 1-3 levels above the letter owner). One of:
specific, dynamic.string
Same as presigner_mode, for the post-signer. One of:
specific, dynamic.object[]
object[]