GOgonitro
Sign

List Participant Signing URLs by Envelope ID

Changed on

The List Participant Signing URLs by Envelope ID endpoint returns the URL and its expiry for each participant of an envelope, for every role. Signers receive a URL into the signing experience; CC participants receive a read-only view URL.

This endpoint is for senders who distribute the links themselves, so it requires the envelope to have notificationsManagedBy set to sender. When Nitro manages the notifications it has already emailed every participant their own link, and the request is rejected with a 409 response. Envelopes default to nitro when created without the field.

Note that a sender-managed envelope can only be sent for signing when every signer authenticates by SMS, so in practice this endpoint serves envelopes that meet that requirement too.

The envelope must also be in the SENT status; otherwise the request is rejected with a 409 response.

get/sign/envelopes/{envelopeID}/participants/signing-urls

Request

  • Base URL
    https://api.gonitro.dev
  • URL
    https://api.gonitro.dev/sign/envelopes/{envelopeID}/participants/signing-urls
  • Auth
    HTTP bearer

Path parameters

envelopeIDstring uuid required

A unique UUIDv4 string that identifies the envelope in the Nitro system.

Response

List participant signing URLs

totalinteger

The total number of items available in the collection

Changes

  • 44cfae4dc99bRevision changes
    • breaking

      added to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id listSignerSigningUrls removed and replaced with listParticipantSigningUrls

    • info

      added the required property // to the response with the status