DocuSign.Api.EnvelopeRecipients.recipients_get_recipients

You're seeing just the function recipients_get_recipients, go back to DocuSign.Api.EnvelopeRecipients module for more information.
Link to this function

recipients_get_recipients(connection, account_id, envelope_id, opts \\ [])

View Source

Specs

recipients_get_recipients(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.EnvelopeRecipients.t()} | {:error, Tesla.Env.t()}

Gets the status of recipients for an envelope. Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :include_anchor_tab_locations (String.t): When set to true and `include_tabs` is set to true, all tabs with anchor tab properties are included in the response.
    • :include_extended (String.t): When set to true, the extended properties are included in the response.
    • :include_tabs (String.t): When set to true, the tab information associated with the recipient is included in the response.

Returns

} on success {:error, info} on failure