Este endpoint retorna uma lista paginada de envelopes do usuário, com opções de filtro por status, texto e data.
curl -X GET "https://api.formsign.com.br/api/envelopes?page=1&pageSize=10&status=sent&searchText=contrato" \
-H "Authorization: Bearer <TOKEN>"
Parâmetros (Query)
Número da página (começa em 1).
Quantidade de itens por página (máximo 50).
Filtrar por status do envelope.
Buscar por texto no assunto ou ID do envelope.
Filtrar por data de início da última atualização (formato YYYY-MM-DD).
Filtrar por data de fim da última atualização (formato YYYY-MM-DD).
Status Disponíveis
| Status | Descrição |
|---|
draft | Rascunho (não enviado) |
sent | Enviado para assinatura |
completed | Todas as assinaturas completas |
voided | Cancelado |
expired | Expirado sem completar |
Respostas
{
"totalPages": 5,
"page": 1,
"pageSize": 10,
"totalRecords": 47,
"envelopes": [
{
"envelopeId": "env_abc123456789",
"subject": "Contrato de Prestação de Serviços",
"status": "sent",
"submissionType": "document",
"creationDate": "2024-08-15T10:30:00Z",
"lastUpdateDate": "2024-08-15T10:35:00Z",
"sentDate": "2024-08-15T10:35:00Z",
"userId": "user_123",
"templateId": "tpl_456",
"recipients": [
{
"recipientId": "rec_789",
"email": "[email protected]",
"name": "João Silva",
"status": "sent",
"role": "signer",
"signatureType": "draw"
}
],
"sender": {
"email": "[email protected]",
"userName": "Maria Santos"
},
"advancedOptions": {
"autoReminders": true,
"reminderDelay": 2,
"reminderFrequency": 3,
"expirationDays": 30,
"expirationWarning": 5
},
"validationKey": "val_xyz789",
"s3Key": "documents/user_123/env_abc123456789.pdf",
"documentSignedS3Key": null,
"completedDate": null,
"expirationDate": "2024-09-14T10:35:00Z"
}
]
}
Campos da Response
Total de páginas disponíveis.
Total de registros encontrados.
Show envelopes[] (Estrutura do Envelope)
Status atual: draft, sent, completed, voided, expired.
envelopes[].submissionType
Tipo de submissão: document, form.
Data de criação (ISO 8601).
envelopes[].lastUpdateDate
Última atualização (ISO 8601).
Data de envio (ISO 8601).
ID do usuário proprietário.
ID do template usado (se aplicável).
envelopes[].advancedOptions
Opções avançadas configuradas.
envelopes[].validationKey
Chave de validação única.
Chave S3 do documento original.
envelopes[].documentSignedS3Key
Chave S3 do documento assinado (se completo).
envelopes[].completedDate
Data de conclusão (se completo).
envelopes[].expirationDate
Data de expiração.
Performance: Para melhor performance, use pageSize entre 10-25. Evite valores muito altos que podem impactar o tempo de resposta.
