/v6/envelope/find

post

https://esign.datasure.net/api/v6/envelope/find

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

StartDate

date-time

length between 20 and 30

If set, filter for envelopes which were sent after the start date. A datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).

EndDate

date-time

length between 20 and 30

If set, filter for envelopes which were sent before the end date. A datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).

SearchText

string

length between 0 and 500

If set, the given text is searched in following fields: envelope name and description notification subject and message sender email address, given name and surname
recipient email address, given name and surname Note: Using this search option is very resource intensive! It might take very long.

Status

string

enum

If set, envelopes in the given status are matched.

InStatusSinceDays

integer

If set, envelopes having the given status for the specified days are matched. It must be combined with Status.

SenderEmail

string

length between 0 and 250

If set, envelopes sent by the user with the given email address are matched.

CompletedByRecipientWithEmail

string

length between 0 and 250

If set, envelopes containing a completed activity, belonging to a recipient with the given email address, are matched.

RecipientEmail

string

length between 0 and 250

If set, envelopes containing a recipient with the given email address are matched.

WaitingForRecipientWithEmail

string

length between 0 and 250

If set, envelopes waiting for the recipient with the given email address are matched.

EnvelopeBulkParentId

string

length between 36 and 36

If set, envelopes belonging to the given BulkParent envelope are matched.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

200OK

400BadRequest

403Forbidden