Envelope History (GET /v2.0/envelopes/{envelopeId}/history)
Get the history of an envelope.
Request Parameters
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {access_token} |
| app_auth_type | jsign-oauth2 |
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| envelopeId | GUID | Yes | Envelope ID |
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| message | The returned message (envelope history) |
Response Body Data Fields
| Field | Always preset | Description |
|---|---|---|
| envelope_id | Yes | Envelope ID |
| envelope_name | Yes | Envelope name with extension |
| envelope_history[] | Yes | Envelope history array |
| envelope_history[].first_name | Yes | First name of the activity performer |
| envelope_history[].last_name | No | Last name of the activity performer |
| envelope_history[].log_time_utc | Yes | Activity time in UTC |
| envelope_history[].content | Yes | Activity text |
| envelope_history[].activity | Yes | Activity type |
Sample Success Response
REQUEST:
curl --location --request GET '/api/v2.0/envelopes/a3374969-02ff-4de1-a8b7-8882ae0db8b9/history' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2'
RESPONSE:
{
"message": "",
"data": {
"envelope_id": "a3374969-02ff-4de1-a8b7-8882ae0db8b9",
"envelope_name": "Sample Envelope",
"envelope_history": [
{
"first_name": "Jon",
"last_name": "Smith",
"log_time_utc": "2021-08-20T07:01:10.79",
"content": "Jon Smith created the document",
"activity": "Created"
}
]
}
}
Sample Error Response
REQUEST:
curl --location --request GET '/api/v2.0/envelopes/c786ceaa-3100-45dd-953a-19aa848f7637/history' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2'
RESPONSE:
{
"errors": [
{
"error_code": "ENVELOPE_NOT_FOUND_OR_RECIPIENT_NO_ACCESS", "
developer_message": "The requested envelope is not found or recipient does not have permission to access envelope."
}
]
}
Note: View the full list of applicable error code for this method here.