Listar sobres
Busca sobres de documentos o plantillas mediante filtros y paginación.
/envelopeURL base: https://business.digito.do/api/v2.
Ejemplos
Configura DIGITO_API_TOKEN en el servidor. Sustituye los IDs y archivos de ejemplo por los de tu equipo. TypeScript usa fetch y FormData de Node.js.
curl --fail-with-body \
--request GET \
--url 'https://business.digito.do/api/v2/envelope?page=1&perPage=10&type=DOCUMENT&status=DRAFT&orderByColumn=createdAt&orderByDirection=desc' \
--header "Authorization: $DIGITO_API_TOKEN"Autenticación
Envía el token de la API en el encabezado Authorization. El acceso corresponde al equipo y a los permisos del token. Conserva el token en tu servidor.
Authorization: api_TU_TOKENAntes de cada acción de firma, el firmante debe autenticarse de nuevo con Digito ID. Una sesión previa de Business, un token de destinatario o un token de la API no sustituye este requisito.
Parámetros
| Nombre | Ubicación | Tipo | Obligatorio | Restricciones |
|---|---|---|---|---|
query | Consulta | string | No | Texto de búsqueda. Sin restricciones adicionales en este nivel. |
page | Consulta | number | No | Número de página; comienza en 1. Mínimo: 1 |
perPage | Consulta | number | No | Cantidad de elementos por página. Mínimo: 1. Máximo: 100 |
type | Consulta | string | No | Filtra por tipo de sobre: DOCUMENT o TEMPLATE. Valores: "DOCUMENT", "TEMPLATE" |
templateId | Consulta | number | No | Filtra por el identificador de la plantilla utilizada. Sin restricciones adicionales en este nivel. |
source | Consulta | string | No | Filtra por el origen del sobre. Valores: "DOCUMENT", "TEMPLATE" |
status | Consulta | string | No | Filtra por el estado actual del sobre. Valores: "DRAFT", "PENDING", "COMPLETED", "REJECTED", "CANCELLED" |
hasExpiredRecipients | Consulta | string | No | Filtra los sobres que tienen al menos un destinatario con un link de firma expirado. Valores: "true", "false" |
folderId | Consulta | string | No | Filtra por el identificador de carpeta. Sin restricciones adicionales en este nivel. |
orderByColumn | Consulta | string | No | Valores: "createdAt" |
orderByDirection | Consulta | string | No | Dirección del orden. Valores: "asc", "desc". Predeterminado: "desc" |
Cuerpo de la solicitud
Esta operación no declara cuerpo de solicitud.
Respuesta de éxito
Esta referencia muestra las propiedades documentadas para Digito. Conserva el resto de la respuesta recibida en tu aplicación.
Este objeto sintético ilustra las propiedades documentadas de una respuesta 200. Los identificadores, fechas, estados y tokens son datos de ejemplo.
{
"data": [
{
"internalVersion": 1,
"type": "DOCUMENT",
"status": "DRAFT",
"source": "DOCUMENT",
"visibility": "EVERYONE",
"templateType": "PRIVATE",
"id": "sobre_de_ejemplo",
"secondaryId": "envelope_secundario_de_ejemplo",
"externalId": null,
"createdAt": "2026-10-06T12:00:00.000Z",
"updatedAt": "2026-10-06T12:00:00.000Z",
"completedAt": null,
"deletedAt": null,
"title": "Contrato de servicios",
"authOptions": null,
"formValues": null,
"publicTitle": "valor_de_ejemplo",
"publicDescription": "valor_de_ejemplo",
"userId": 1,
"teamId": 1,
"folderId": null,
"templateId": null,
"user": {
"id": 1,
"name": "Luis Ejemplo",
"email": "integracion@example.com"
},
"recipients": [
{
"envelopeId": "sobre_de_ejemplo",
"role": "SIGNER",
"readStatus": "NOT_OPENED",
"signingStatus": "NOT_SIGNED",
"sendStatus": "NOT_SENT",
"id": 501,
"email": "ana@example.com",
"name": "Ana Ejemplo",
"token": "token_de_destinatario_ejemplo",
"documentDeletedAt": null,
"expired": null,
"expiresAt": null,
"expirationNotifiedAt": null,
"signedAt": null,
"authOptions": null,
"signingOrder": null,
"signerCedula": null,
"rejectionReason": null
}
],
"team": null
}
],
"count": 1,
"currentPage": 1,
"perPage": 10,
"totalPages": 1
}Respuestas y errores
| Estado | Descripción | Contenido y esquema |
|---|---|---|
200 | Respuesta correcta. | application/json |
400 | Datos de entrada inválidos. | application/json |
401 | No se proporcionó autorización. | application/json |
403 | Permisos insuficientes. | application/json |
404 | Recurso no encontrado. | application/json |
500 | Error interno del servidor. | application/json |
Los esquemas enlazados incluyen propiedades anidadas, campos obligatorios, variantes, enumeraciones, nulabilidad y restricciones. Consulta errores y reintentos para manejar respuestas no exitosas.
Identificador de operación: envelope-find.