Retrieve eSignature transactions by status

This endpoint retrieves a list of eSignature transactions filtered by the provided status. Authorization (HTTP bearer token) is required.

Path Parameters
status string — REQUIRED The status of the eSignature transactions to be retrieved (e.g., 'pending', 'completed', 'canceled').

Responses

200 A list of eSignature transactions with the specified status successfully retrieved. Schema — OPTIONAL data object[] List of transactions. id uuid The unique identifier of the transaction. status string The current status of the transaction. taggingOrganizationId string — OPTIONAL The ID of the organization assigned to tag this document. documents object[] List of documents in the transaction. id string — OPTIONAL id of the document from response from POST /document/upload title string document title description string — OPTIONAL document description xfdf string — OPTIONAL document xfdf string StoragePath string StoragePath of document from response POST /document/upload order number — OPTIONAL order the document is shown to participant pages number — OPTIONAL number of pages in the document readOnly boolean — OPTIONAL will this document be read only visible boolean — OPTIONAL will this document be visible to the participants tags object[] List of tags to convert to xfdf type string Possible values: [DATETEMPLATE, FULLNAMETEMPLATE, DOCUMENTIDTEMPLATE, NOTARYSESSIONIDTEMPLATE, COMMISSIONIDTEMPLATE, COMMISSIONEXPIRATIONTEMPLATE, DISCLAIMERTEMPLATE, COMMISSIONSTAMPTEMPLATE, SEALTAGTEMPLATEANNOTATION, NOTARYTITLETEMPLATE, NOTARYCOUNTYTEMPLATE, NOTARYSTATETEMPLATE, SIGNATURETEMPLATE, SIGNHERETAGTEMPLATEANNOTATION, INITIALSTEMPLATE, INITIALHERETAGTEMPLATEANNOTATION, FREEFORMTEXTTAGTEMPLATEANNOTATION, TEXTANNOT] x number bottom-left x-coordinate of the tag annotation y number bottom-left y-coordinate of the tag annotation width number width of the tag annotation height number height of the tag annotation signerId string id of the signer this tag is assigned to customData object page number page number of the tag annotation required boolean — OPTIONAL tag is required to be applied stateFormat string — OPTIONAL tag is required to be applied dateFormat string — OPTIONAL Possible values: [MM/DD/YYYY, DD/MM/YYYY, MM/DD/YY, DD/MM/YY, MMMM do, yyyy, full, MMMM, do, yyyy, YYYY] tag is required to be applied fontSize number — OPTIONAL tag font size participants object[] List of participants in the transaction. id string id of the signer this tag is assigned to order number — OPTIONAL order of participant email string email of the signer firstName string first name of signer middleName string — OPTIONAL middle name of signer lastName string last name of signer address1 string — OPTIONAL address of signer address2 string — OPTIONAL address 2 of signer country string — OPTIONAL country of signer city string — OPTIONAL address 2 of signer state string — OPTIONAL state of signer zip string — OPTIONAL postal code of signer phone string — OPTIONAL phone number of signer kbaRequired boolean — OPTIONAL is KBA required for this signer credAnalysisRequired boolean — OPTIONAL is credential-analysis required for this signer externalId string — OPTIONAL consumer-provided external id authenticationType string Possible values: [personal-password, two-factor-authentication, none] twoFactorContact string Possible values: [sms, email] personalPasswordQuestion string — OPTIONAL personalPassword string — OPTIONAL inviteEmailSubject string — OPTIONAL viewOnly boolean — OPTIONAL Request field. When true, this participant is a view-only recipient who can access and view documents but cannot sign, fill in tags, or modify any document content. View-only recipients do not block transaction completion, and tags may not be assigned to them (doing so returns a 400). Setting viewOnly=true automatically makes the participant a non-signer. role string — OPTIONAL Response field. The resolved role of the participant: "signer", "non-signer", "view-only", or a custom role name from a template. viewStatus string — OPTIONAL Possible values: [pending, viewed] Response field. View status of a view-only participant: "pending" if they have not yet viewed the documents, "viewed" if they have. Present only for view-only participants. viewedAt date-time — OPTIONAL Response field. ISO 8601 timestamp of when a view-only participant first viewed the documents, or null if not yet viewed. Present only for view-only participants. emailSubject string — OPTIONAL Custom email subject line used for signer notification emails. Present only if a custom subject was set at envelope creation. showConfetti boolean — OPTIONAL V2-12387 — Whether confetti will play for the signer after signing completes. useReplyTo boolean — OPTIONAL V2-12387 — Whether outgoing eSign emails include a Reply-To header. NOTE: this is the order-level setting and may be overridden by the brand — see replyToOverriddenByBrand and effectiveReplyTo. replyToEmail email — OPTIONAL V2-12387 — Order-level Reply-To stored on the eSign. May be overridden by the brand. replyToOverriddenByBrand boolean V2-12387 — True when this transaction has a brandId whose brand has emailConfigEnabled AND a resolved sender email — in which case the brand's Reply-To wins over the order-level Reply-To. When true, outgoing emails will use effectiveReplyTo (the brand's address) regardless of useReplyTo / replyToEmail. effectiveReplyTo email — OPTIONAL V2-12387 — The Reply-To address that will actually be applied to outgoing emails for this transaction, after the precedence: brand Reply-To > order-level Reply-To > null. Null when useReplyTo is false and no brand override is active. assignedGroupId uuid — OPTIONAL V2-12387 — UUID of the team/group this transaction is assigned to, if any. allowSignerNameEdit boolean — OPTIONAL V2-12387 — Whether signers may edit their own name during the signing process. fileReference string — OPTIONAL V2-12387 — Initiator-supplied tracking identifier stored on the Transaction record. total integer Total number of transactions matching the query.