v1
latestOpenAPI 3.1.02026-07-24560263.9 KBListar Signatários
Listar Signatários de um Envelope
get/envelopes/{envelope_id}/signers
Path parameters
envelope_idstring required
ID do envelope ao qual deseja listar os signatários
Headers
Authorizationstring required
Access Token gerado pelo gestor da conta
Content-type'application/vnd.api+json'
Content-type padrão para todas requisições JSON:API
Response
200
Example response
{
"data": [
{
"id": "305b7b99-7669-4b1b-b0a9-7cbf61ffc680",
"type": "signers",
"links": {
"self": "https://sandbox.clicksign.com/api/v3/envelopes/b8239d23-230a-4ab7-82f2-6d68b3fee0fd/signers/305b7b99-7669-4b1b-b0a9-7cbf61ffc680"
},
"attributes": {
"name": "Signer One",
"email": "signer.one@example.com",
"has_documentation": true,
"group": 1,
"communicate_events": {
"document_signed": "email",
"signature_request": "email",
"signature_reminder": "email"
},
"created": "2024-03-07T09:15:01.530-03:00",
"modified": "2024-03-07T09:15:01.530-03:00"
}
}
],
"meta": {
"record_count": 2
},
"links": {
"first": "https://sandbox.clicksign.com/api/v3/envelopes/b8239d23-230a-4ab7-82f2-6d68b3fee0fd/signers?page%5Bnumber%5D=1&page%5Bsize%5D=20",
"last": "https://sandbox.clicksign.com/api/v3/envelopes/b8239d23-230a-4ab7-82f2-6d68b3fee0fd/signers?page%5Bnumber%5D=1&page%5Bsize%5D=20"
}
}