Listar participantes do envelope

Sandbox

GET

/v4/api/envelopes/{envelopeId}/participants

Retorna participantes e o andamento de cada um sem expor tokens ou links privados de assinatura.

Requisição

Authorization

Bearer Token

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Respostas

🟢200OK

application/json

Headers

Bodyapplication/json

🟠401Não Autorizado

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v4/api/envelopes//participants' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Exemplo 1

{
    "signatories": [
        {
            "id": "string",
            "type": "INDIVIDUAL",
            "role": "SIGNATORY",
            "roleName": "string",
            "envelopeId": "string",
            "userId": "string",
            "group": {
                "id": "string",
                "name": "string"
            },
            "name": "string",
            "email": "string",
            "phoneNumber": "string",
            "status": "CREATED",
            "deliveryMethod": "EMAIL",
            "order": 0,
            "emailTracking": {
                "status": "SENT",
                "sentAt": "2019-08-24T14:15:22.123Z",
                "deliveredAt": "2019-08-24T14:15:22.123Z",
                "openedAt": "2019-08-24T14:15:22.123Z",
                "clickedAt": "2019-08-24T14:15:22.123Z",
                "bouncedAt": "2019-08-24T14:15:22.123Z"
            },
            "whatsappTracking": {
                "messageId": "string",
                "status": "SENT",
                "sentAt": "2019-08-24T14:15:22.123Z",
                "deliveredAt": "2019-08-24T14:15:22.123Z",
                "failedAt": "2019-08-24T14:15:22.123Z",
                "errorCode": 0,
                "errorMessage": "string",
                "precedence": 0
            },
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "qualification": "string",
            "documentNumber": "string",
            "authMethod": "EMAIL",
            "isForeigner": true
        }
    ],
    "approvers": [
        {
            "id": "string",
            "type": "INDIVIDUAL",
            "role": "SIGNATORY",
            "roleName": "string",
            "envelopeId": "string",
            "userId": "string",
            "group": {
                "id": "string",
                "name": "string"
            },
            "name": "string",
            "email": "string",
            "phoneNumber": "string",
            "status": "CREATED",
            "deliveryMethod": "EMAIL",
            "order": 0,
            "emailTracking": {
                "status": "SENT",
                "sentAt": "2019-08-24T14:15:22.123Z",
                "deliveredAt": "2019-08-24T14:15:22.123Z",
                "openedAt": "2019-08-24T14:15:22.123Z",
                "clickedAt": "2019-08-24T14:15:22.123Z",
                "bouncedAt": "2019-08-24T14:15:22.123Z"
            },
            "whatsappTracking": {
                "messageId": "string",
                "status": "SENT",
                "sentAt": "2019-08-24T14:15:22.123Z",
                "deliveredAt": "2019-08-24T14:15:22.123Z",
                "failedAt": "2019-08-24T14:15:22.123Z",
                "errorCode": 0,
                "errorMessage": "string",
                "precedence": 0
            },
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    ],
    "observers": [
        {
            "id": "string",
            "type": "INDIVIDUAL",
            "role": "SIGNATORY",
            "roleName": "string",
            "envelopeId": "string",
            "userId": "string",
            "group": {
                "id": "string",
                "name": "string"
            },
            "name": "string",
            "email": "string",
            "phoneNumber": "string",
            "status": "CREATED",
            "deliveryMethod": "EMAIL",
            "order": 0,
            "emailTracking": {
                "status": "SENT",
                "sentAt": "2019-08-24T14:15:22.123Z",
                "deliveredAt": "2019-08-24T14:15:22.123Z",
                "openedAt": "2019-08-24T14:15:22.123Z",
                "clickedAt": "2019-08-24T14:15:22.123Z",
                "bouncedAt": "2019-08-24T14:15:22.123Z"
            },
            "whatsappTracking": {
                "messageId": "string",
                "status": "SENT",
                "sentAt": "2019-08-24T14:15:22.123Z",
                "deliveredAt": "2019-08-24T14:15:22.123Z",
                "failedAt": "2019-08-24T14:15:22.123Z",
                "errorCode": 0,
                "errorMessage": "string",
                "precedence": 0
            },
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "mandatoryView": true
        }
    ]
}

Modificado em 2026-09-06 20:28:54

Página anterior

Sincronizar participantes do envelope

Próxima página

Enviar lembrete ao participante