Lista paginada de sobres
Contrato de respuesta: lista paginada de sobres.
Este esquema conserva los nombres técnicos, tipos y restricciones de la API. Las propiedades incluidas en required son obligatorias; nullable admite null. oneOf requiere una variante, anyOf admite las variantes indicadas y allOf combina sus restricciones.
Esta referencia muestra las propiedades documentadas para Digito. Conserva el resto de la respuesta recibida en tu aplicación.
Propiedades principales
| Propiedad | Tipo | Obligatoria | Restricciones |
|---|---|---|---|
data | array de object | Sí | Sin restricciones adicionales en este nivel. |
count | number | Sí | Sin restricciones adicionales en este nivel. |
currentPage | number | Sí | Sin restricciones adicionales en este nivel. |
perPage | number | Sí | Sin restricciones adicionales en este nivel. |
totalPages | number | Sí | Sin restricciones adicionales en este nivel. |
Ejemplo de la estructura
Este objeto es una muestra sintética de la estructura. Los identificadores, fechas, estados y tokens sirven como ejemplos de formato; no describen una operación real ni valores predeterminados.
{
"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
}Ver el esquema JSON de la referencia
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"internalVersion": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"DOCUMENT",
"TEMPLATE"
]
},
"status": {
"type": "string",
"enum": [
"DRAFT",
"PENDING",
"COMPLETED",
"REJECTED",
"CANCELLED"
]
},
"source": {
"type": "string",
"enum": [
"DOCUMENT",
"TEMPLATE"
]
},
"visibility": {
"type": "string",
"enum": [
"EVERYONE",
"MANAGER_AND_ABOVE",
"ADMIN"
]
},
"templateType": {
"type": "string",
"enum": [
"PUBLIC",
"PRIVATE",
"ORGANISATION"
]
},
"id": {
"type": "string"
},
"secondaryId": {
"type": "string"
},
"externalId": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"completedAt": {
"type": "string",
"nullable": true
},
"deletedAt": {
"type": "string",
"nullable": true
},
"title": {
"type": "string"
},
"authOptions": {
"type": "object",
"nullable": true,
"properties": {
"globalAccessAuth": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ACCOUNT",
"TWO_FACTOR_AUTH"
]
}
},
"globalActionAuth": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ACCOUNT",
"PASSKEY",
"TWO_FACTOR_AUTH",
"PASSWORD"
]
}
}
},
"required": [
"globalAccessAuth",
"globalActionAuth"
]
},
"formValues": {
"type": "object",
"nullable": true,
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "boolean"
},
{
"type": "number"
}
]
}
},
"publicTitle": {
"type": "string"
},
"publicDescription": {
"type": "string"
},
"userId": {
"type": "number"
},
"teamId": {
"type": "number"
},
"folderId": {
"type": "string",
"nullable": true
},
"templateId": {
"type": "number",
"nullable": true
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
}
},
"required": [
"id",
"name",
"email"
]
},
"recipients": {
"type": "array",
"items": {
"type": "object",
"properties": {
"envelopeId": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
"CC",
"SIGNER",
"VIEWER",
"APPROVER",
"ASSISTANT"
]
},
"readStatus": {
"type": "string",
"enum": [
"NOT_OPENED",
"OPENED"
]
},
"signingStatus": {
"type": "string",
"enum": [
"NOT_SIGNED",
"SIGNED",
"REJECTED"
]
},
"sendStatus": {
"type": "string",
"enum": [
"NOT_SENT",
"SENT"
]
},
"id": {
"type": "number"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"token": {
"type": "string"
},
"documentDeletedAt": {
"type": "string",
"nullable": true
},
"expired": {
"type": "string",
"nullable": true
},
"expiresAt": {
"type": "string",
"nullable": true
},
"expirationNotifiedAt": {
"type": "string",
"nullable": true
},
"signedAt": {
"type": "string",
"nullable": true
},
"authOptions": {
"type": "object",
"nullable": true,
"properties": {
"accessAuth": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ACCOUNT",
"TWO_FACTOR_AUTH"
]
}
},
"actionAuth": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ACCOUNT",
"PASSKEY",
"TWO_FACTOR_AUTH",
"PASSWORD",
"EXPLICIT_NONE"
]
}
}
},
"required": [
"accessAuth",
"actionAuth"
]
},
"signingOrder": {
"type": "number",
"nullable": true
},
"signerCedula": {
"type": "string",
"nullable": true
},
"rejectionReason": {
"type": "string",
"nullable": true
}
},
"required": [
"envelopeId",
"role",
"readStatus",
"signingStatus",
"sendStatus",
"id",
"email",
"name",
"token",
"documentDeletedAt",
"expired",
"expiresAt",
"expirationNotifiedAt",
"signedAt",
"authOptions",
"signingOrder",
"signerCedula",
"rejectionReason"
]
}
},
"team": {
"type": "object",
"nullable": true,
"properties": {
"id": {
"type": "number"
},
"url": {
"type": "string"
}
},
"required": [
"id",
"url"
]
}
},
"required": [
"internalVersion",
"type",
"status",
"source",
"visibility",
"templateType",
"id",
"secondaryId",
"externalId",
"createdAt",
"updatedAt",
"completedAt",
"deletedAt",
"title",
"authOptions",
"formValues",
"publicTitle",
"publicDescription",
"userId",
"teamId",
"folderId",
"templateId",
"user",
"recipients",
"team"
]
}
},
"count": {
"type": "number"
},
"currentPage": {
"type": "number"
},
"perPage": {
"type": "number"
},
"totalPages": {
"type": "number"
}
},
"required": [
"data",
"count",
"currentPage",
"perPage",
"totalPages"
]
}