List web form instances | Docusign

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "formUrl": "https://webforms-ux/v1.0/forms/82356c8f286b4e4df592af7d0984f51d",
      "instanceToken": "string",
      "tokenExpirationDateTime": "2024-01-15T09:30:00Z",
      "formId": "00000000-0000-0000-0000-000000000000",
      "accountId": "00000000-0000-0000-0000-000000000000",
      "clientUserId": "customer_id@domain.com",
      "tags": [
        "loan_application",
        "finance_dept"
      ],
      "status": "INITIATED",
      "envelopes": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "createdDateTime": "2024-01-15T09:30:00Z"
        }
      ],
      "instanceMetadata": {
        "expirationDateTime": "2023-08-16T10:30:00Z",
        "createdDateTime": "2023-08-15T10:30:00Z",
        "createdBy": {
          "userId": "00000000-0000-0000-0000-000000000000",
          "userName": "DocuSign User"
        },
        "lastModifiedDateTime": "2023-08-15T20:30:00Z",
        "lastModifiedBy": {
          "userId": "00000000-0000-0000-0000-000000000000",
          "userName": "DocuSign User"
        }
      },
      "formValues": {
        "Checkbox_hobbies": [
          "singing",
          "dancing"
        ],
        "Date_birth": "2020-01-01",
        "Email_primary": "example@example.com",
        "ID_card_attachment": {
          "documentName": "id_card.pdf"
        },
        "Number_age": 52,
        "Radio_Gender": "Female",
        "Select_state": "California",
        "Textbox_Name": "First Last"
      },
      "brandId": "00000000-0000-0000-0000-000000000000",
      "recipients": [
        {
          "recipientViewId": "00000000-0000-0000-0000-000000000000",
          "instanceRecipientStatus": "SUBMITTED",
          "roleName": "Applicant"
        }
      ]
    }
  ]
}

The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact Docusign Support or your account manager to find out whether the Web Forms API is available for your production account plan.

Retrieves all the instances of a given web form configuration.

Required authentication scopes: signature, webforms_instance_read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequiredformat: "uuid"

The ID of the account to which the web form belongs.

formIdstringRequiredformat: "uuid"

The ID of the form configuration.

Query parameters

client_user_idstringOptional<=100 characters

A unique identifier for a user from the client's system. This value can be anything your backend system would use to track individual form instances, such as employee IDs, email addresses, or surrogate key values.

Response

List of all Web Form Instances with associated metadata.

itemslist of objectsOptional

Array of web form instance items.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error