List envelopes
Query Parameters
Match envelopes whose name contains this string
Request pre-defined view. inbox returns envelopes where action is required by the caller. sent returns envelopes created by the caller. action returns envelopes where action is required by the caller. waiting returns envelopes where action is required by anyone. completed returns envelopes where all actions are complete.
"inbox" | "sent" | "action" | "waiting" | "completed"Match envelopes in one of the specified states.
If true, include organizations-shared envelopes
"false"Match envelopes created from the specified template ID
uuidMatch envelopes created before this date
dateMatch envelopes created after this date
dateReturn results sorted by this criteria
"name" | "created_at" | "updated_at" | "canceled_at" | "status"Set true/false to override the sort direction. Note that the default depends on sort_by. Date-based sorts default to descending, while name and status default to ascending.
Limit the number of rows returned
20Specify which page of results to return
0Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.verdocs.com/v2/envelopes"{
"count": 0,
"rows": 0,
"page": 0,
"envelopes": [
{
"canceled_at": "string",
"created_at": "string",
"data": "string",
"documents": "string",
"expires_at": "string",
"followup_reminders": "string",
"id": "string",
"initial_reminder": "string",
"max_reminder_days": 0,
"name": "string",
"next_reminder": "string",
"no_contact": true,
"organization_id": "string",
"profile_id": "string",
"sender_email": "string",
"sender_name": "string",
"signed": true,
"status": "string",
"template_id": "string",
"updated_at": "string",
"visibility": "string"
}
]
}{
"status": "ERROR",
"error": "string"
}{
"status": "ERROR",
"error": "string"
}{
"status": "ERROR",
"error": "string"
}{
"status": "ERROR",
"error": "string"
}