DOCUMENTATION DÉVELOPPEUR
/Vue d'ensemble de l'API
//Get envelope
Returns a specific envelope.
Sécurité
Bearer or PersonalAccessToken
GET
curl -i -X GET \
'/api/v1/organizations/{organizationId}/envelopes/{envelopeId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'OK
When the envelope was last updated.
Exemple:"2025-01-01T10:00:00Z"
expirationAbsoluteEnvelopeExpirationResponse (object) or RelativeEnvelopeExpirationResponse (object) or (any or null)
One of:
Absolute expiration configuration.
Whether all signatures in the envelope must use a qualified timestamp server.
Exemple:true
The signature format for an envelope or template.
Enum:"Pades""Cades"
The signature reason persisted on the envelope, or null.
Exemple:"Approved by Mario Rossi"
The reason for the envelope's terminal status change: the rejection reason when rejected, the cancellation reason when cancelled, otherwise null.
Exemple:"Document no longer required"
The agreements per language, or null when no custom agreements are configured.
Whether file visibility is restricted per recipient.
Exemple:false
The URL to redirect to after sending the envelope.
Exemple:"https://example.com/envelope-sent"
Réponse
{ "id": "00000000-0000-0000-0000-000000000001", "name": "Contract for Mario Rossi", "status": "Draft", "createdAt": "2025-01-01T10:00:00+00:00", "updatedAt": "2025-01-01T10:00:00+00:00", "expiration": { "mode": "Absolute", "expiresAt": "2026-12-11T14:00:03.1810163+00:00" }, "reminder": { "enabled": true, "firstReminderInDays": 5, "resendIntervalInDays": 3, "beforeExpirationInDays": 2 }, "stages": [ { … } ], "files": [ { … } ], "sentAt": null, "qualifiedTimeStamp": true, "signatureFormat": "Pades", "signatureReason": "Approved by Mario Rossi", "statusChangeReason": "Document no longer required", "agreements": null, "fileRestrictedVisibility": false, "afterSendRedirectUrl": "https://example.com/envelope-sent", "bulkEnvelopeId": null }