Role
A Role defines a participant position on a Template. Each role has a type (signer, witness, or approver) and is linked to specific fields on the template via the signerIndex.
Fields
| Field | Type | Description |
|---|---|---|
id | ID! | Unique identifier |
name | String! | Descriptive title (e.g. "Tenant", "Witness") |
roleType | ROLETYPE | SIGNER, WITNESS, or APPROVER |
signerIndex | Int! | Field indicator linking this role to template elements |
ordinal | Int! | Display order on the template |
signerParent | ID | Parent role ID (used for witnesses linked to a signer) |
experience | ID | Experience ID for this participant |
Query
Roles are accessed as a field on Template:
query GetTemplateRoles {
template(id: "dHBsYjQ5YTg5NWQtYWRhMy0xMWYwLWIxZGMtMDY5NzZlZmU0MzIx") {
roles {
id
name
roleType
signerIndex
ordinal
signerParent
experience
}
}
}
Related
- Template — the template this role belongs to
- Recipient — recipients are assigned roles when a document is sent
- Experience — the signing experience for this role