Get envelope details

GET

/v2/envelopes/{envelopeId}

Requisição

Authorization

JWT Bearer

Adicionar o parâmetro

Authorization

a Cabeçalhos

Exemplo:

Authorization: ********************

Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200OK

application/json

Success

Body

🟠403Proibido

🟠404Registro Não Encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/v2/envelopes/' \
--header 'x-account-id;' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Exemplo 1

{
    "id": "string",
    "title": "string",
    "status": "DRAFT",
    "deadline": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "hasSigningOrder": true,
    "documents": [
        {
            "id": "string",
            "name": "string",
            "originalFileKey": "string",
            "signedFileKey": "string"
        }
    ],
    "signatories": [
        {
            "id": "string",
            "name": "string",
            "email": "string",
            "phoneNumber": "string",
            "signatureToken": "string",
            "status": "PENDING",
            "qualification": "string",
            "authenticationMethod": "EMAIL",
            "signingOrder": 0
        }
    ],
    "observers": [
        {
            "email": "user@example.com"
        }
    ],
    "logs": [
        {
            "id": "string",
            "actorName": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "eventType": "ENVELOPE_CREATED",
            "details": null
        }
    ]
}

Modificado em 2025-11-21 19:52:25

Página anterior

List envelopes

Próxima página

Send signature request reminder