Skip to main content
GET
List an agreement's signers

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

200 - application/json

Default Response

uuid
string
required
role_name
string
required

The template role this signer fills (e.g. signer, approver).

routing_order
number
required

Signing order within the envelope; 1 signs first.

contact_uuid
string | null
required

Partnership contact this signer resolves to, when the role kind is partner_contact.

user_uuid
string | null
required

Company member this signer resolves to, when the role kind is company_user.

email
string
required
name
string
required
status
enum<string>
required

Recipient lifecycle, reported by the provider's installation: pending until the send, then sent, viewed, signed or declined.

Available options:
pending,
sent,
viewed,
signed,
declined
sent_at
string | null
required
viewed_at
string | null
required
signed_at
string | null
required
declined_at
string | null
required