Skip to main content

recipient

Returns a single Recipient by ID. A Recipient is a person who has been sent a document to sign — distinct from a template Role.

Arguments

ArgumentTypeRequiredDescription
idIDNoGlobal node ID
recipientIdIDNoRecipient-specific ID

Provide either id or recipientId.

Return Type

Recipient

Example

query GetRecipient($id: ID!) {
recipient(id: $id) {
id
firstName
lastName
email
phoneNumber
role
roleType
status
authentication
signedDateTime
sentDateTime
emailOpenedDateTime
documentFirstViewedDateTime
emailProblem
expiryDate
recipientOrder
document {
id
name
status
}
elementConnection {
documentElements {
id
elementType
label
value
}
}
}
}

Export This Article

Save a copy of this page as PDF or plain text.