v2

latestOpenAPI 3.0.32026-07-31890635.1 KB

Document Recipients

Get document recipient

Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Returns a single recipient. If you want to retrieve all the recipients for a document, use the "Get Document" endpoint.

get/document/recipient/{recipientId}

Path parameters

recipientIdnumber required

Response

Successful response

envelopeIdstring required

role'CC' | 'SIGNER' | 'VIEWER' | 'APPROVER' | 'ASSISTANT' required

readStatus'NOT_OPENED' | 'OPENED' required

signingStatus'NOT_SIGNED' | 'SIGNED' | 'REJECTED' required

sendStatus'NOT_SENT' | 'SENT' required

idnumber required

emailstring required

namestring required

tokenstring required

documentDeletedAtstring nullable required

expiredstring nullable required

expiresAtstring nullable required

expirationNotifiedAtstring nullable required

signedAtstring nullable required

signingOrdernumber nullable required

rejectionReasonstring nullable required

documentIdnumber nullable

templateIdnumber nullable