How to find the next step required on an envelope?

Question

Let’s says I use this envelope endpoint to return a list of envelopes that I’m interested in:
GET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}

For each envelope, how can I find the next steps required to progress the envelope to a completed status or closer to that status. Should I get the recipients result for the envelope and check the status of the signers? Should I do that for the agents, carbonCopies, editors, witnesses, etc? Is there some api call that can do that?

Ivan.Dinkov · Accepted Answer

Hi ​@fechinI believe the endpointGET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId} is for a single envelopeIf you want to query multiple envelopes, you would useGET /restapi/v2.1/accounts/{accountId}/envelopesRegarding your questions, the best will be to list envelopes and their recipientGET /restapi/v2.1/accounts/{accountId}/envelopes?from_date=2021-01-01&including=recipientsA recipient is still pending if their status is one of:sent → email notification sent, recipient hasn’t opened.delivered → recipient has viewed, but hasn’t finished required actions.faxpending → waiting for fax to be received.Statuses that are not pending:completed or signed → recipient has finished.declined → recipient refused (envelope cannot complete unless corrected).created → draft stage; envelope not yet sent.Sort recipients by routingOrder and pick the first recipient whose status is pending (sent, delivered, or faxpending). That recipient is the one blocking envelope completion and needs the next action (open/sign/fax).I hope this helps

Sign up

You can login or register as either a Docusign customer or developer. If you don’t already have a Docusign customer or developer account, you can create one for free when registering.

Docusign Community

You can login or register as either a Docusign customer or developer. If you don’t already have a Docusign customer or developer account, you can create one for free when registering.