Skip to content

List envelopes

Request

Returns a paginated list of envelopes for the specified organization.

Security
Bearer or PersonalAccessToken
Path
organizationIdstring, (uuid)required

Unique identifier of the organization

Query
UpdatedBeforestring, (date-time)

Filter envelopes updated before this date.

UpdatedAfterstring, (date-time)

Filter envelopes updated after this date.

SentBeforestring, (date-time)

Filter envelopes sent before this date.

SentAfterstring, (date-time)

Filter envelopes sent after this date.

Statusstring(EnvelopeStatusFilter)

Filter envelopes by status.

Enum:"Canceled""Completed""Draft""Expired""InProgress""Rejected"
Pageinteger, (int32)

The page number.

PageSizeinteger, (int32)

The number of items per page.

SortingKeystring(EnvelopeSortingKey)

The sorting key.

Enum:"LastUpdated""Name"
Ascendingboolean

Whether to sort in ascending order.

GET
/api/v1/organizations/{organizationId}/envelopes
curl -i -X GET \
  '/api/v1/organizations/{organizationId}/envelopes?UpdatedBefore=2019-08-24T14%3A15%3A22Z&UpdatedAfter=2019-08-24T14%3A15%3A22Z&SentBefore=2019-08-24T14%3A15%3A22Z&SentAfter=2019-08-24T14%3A15%3A22Z&Status=Canceled&Page=0&PageSize=0&SortingKey=LastUpdated&Ascending=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
envelopesArray of objects(EnvelopeSummary)required

The list of envelopes.

paginationobject(PaginationResponse)required

Pagination metadata.

Response
{ "envelopes": [ { … } ], "pagination": { "page": 1, "pageSize": 50, "totalCount": 1 } }