In docusign can i request status for a list of envelope ID

Question

I am exploring docusign API. I am trying to understand if the following is possible with status API

Is it possible to request the status for a set of Envelope Ids. I have seen the documentation for requesting status for ONE envelope id.

Thanks for reading

Answer 1

Yes you can easily request statuses for a set of envelopes through the DocuSign API. I recommend going through the DocuSign Developer Center which introduces tools such as the API Explorer and the API Walkthroughs in the Getting Started section.

Take a look at the 5th (middle) walkthrough here, titled Get Status of Envelopes - http://iodocs.docusign.com/apiwalkthroughs

The walkthrough shows you the api call in 6 languages (PHP, Java, Javascript, C#, Python, Objective-C) for getting status of a set of envelopes. Using URL params you can filter by status and date.

The API call you need to make is:

Method

GET

URI

/accounts/{accountId}/envelopes

Optional URL params

1. from_date (url encoded)
2. status (filter by real-time envelope status)

As mentioned the from_date needs to be URL encoded. For instance, to filter all envelopes that are sent, delivered, or completed since March 1, 2014, you would append the following to the URL:

/envelopes?from_date=3%2F1%2F2014&status=sent,delivered,completed

Answer 2

Yes DocuSign allows retrieving statuses for multiple envelopes.

However, I actually found the above documentation to be inaccurate and missing some info. The HTTP method should be GET and the parameter should be named envelope_ids.

So that would give you an example query of:

GET /accounts/{accountId}/envelopes/status?envelope_ids=abc,def

The response contains the standard DocuSign pagination fields, but they don't seem to be processed if included in the request. There is no mention in the docs as the maximum number of envelopes that can be retrieved at a time.