Relatório de envelopes

Sandbox

GET

/v4/api/reports/envelopes

Lista os envelopes da conta com resumo agregado (enviados, concluídos, pendentes, cancelados), filtros por período, status e participante, e paginação. Só para proprietário, administrador ou membro com a permissão de ver relatórios; os demais recebem 403.

Requisição

Parâmetros de Consulta

Respostas

🟢200OK

application/json

Sucesso

Headers

Bodyapplication/json

🟠401Não Autorizado

🟠403Proibido

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v4/api/reports/envelopes?startDate=undefined&endDate=undefined&page=undefined&perPage=undefined&status=undefined&query=undefined&email=undefined&name=undefined&phone=undefined'

Response Example

200 - Exemplo 1

{
    "summary": {
        "totalSent": 0,
        "totalCompleted": 0,
        "totalPending": 0,
        "totalCancelled": 0
    },
    "envelopes": [
        {
            "id": "string",
            "title": "string",
            "status": "string",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "completedAt": "2019-08-24T14:15:22.123Z",
            "cancelledAt": "2019-08-24T14:15:22.123Z",
            "creator": {
                "id": "string",
                "name": "string"
            }
        }
    ],
    "meta": {
        "page": 0,
        "perPage": 0,
        "totalCount": 0,
        "totalPages": 0
    }
}

Modificado em 2026-09-28 20:20:33

Página anterior

Listar envelopes anulados

Próxima página

Relatório de uso por grupo