Get web form configuration | Docusign

{
  "accountId": "00000000-0000-0000-0000-000000000000",
  "formContent": {
    "components": {
      "Root_Of_Journey": {
        "componentKey": "Root_Of_Journey",
        "componentType": "Root",
        "children": [
          "Step_abc123"
        ]
      },
      "Step_abc123": {
        "componentKey": "Step_abc123",
        "componentType": "Step",
        "componentName": "Step_abc123",
        "text": "Patient Demographics"
      },
      "TextBox_ABC123": {
        "componentKey": "TextBox_ABC123",
        "componentType": "TextBox",
        "componentName": "Full_Name",
        "label": "Full Name",
        "maxLength": 100,
        "multiLine": false,
        "placeholder": "John Adams",
        "required": true
      }
    },
    "isStandalone": true,
    "brandId": "00000000-0000-0000-0000-000000000000",
    "templates": [
      {
        "originalTemplateId": "00000000-0000-0000-0000-000000000000",
        "clonedTemplateId": "00000000-0000-0000-0000-000000000000",
        "importedDateTime": "2024-01-15T09:30:00Z",
        "recipientIds": [
          "string"
        ]
      }
    ]
  },
  "formMetadata": {
    "source": "templates",
    "owner": {
      "userId": "00000000-0000-0000-0000-000000000000",
      "userName": "DocuSign User"
    },
    "sender": {
      "userId": "00000000-0000-0000-0000-000000000000",
      "userName": "Sam Sender"
    },
    "formContentModifiedBy": {
      "userId": "00000000-0000-0000-0000-000000000000",
      "userName": "Mary Modifier"
    },
    "formPropertiesModifiedBy": {
      "userId": "00000000-0000-0000-0000-000000000000",
      "userName": "Fred Modifier"
    },
    "lastPublishedBy": {
      "userId": "00000000-0000-0000-0000-000000000000",
      "userName": "Pam Publisher"
    },
    "lastEnabledBy": {
      "userId": "00000000-0000-0000-0000-000000000000",
      "userName": "Everly Enabler"
    },
    "lastDisabledBy": {
      "userId": "00000000-0000-0000-0000-000000000000",
      "userName": "Dan Disabler"
    },
    "archivedDateTime": "2022-01-01T10:30:00Z",
    "createdDateTime": "2021-09-01T10:30:00Z",
    "lastModifiedDateTime": "2021-09-01T10:30:00Z",
    "formContentModifiedDateTime": "2021-09-01T10:30:00Z",
    "formPropertiesModifiedDateTime": "2021-09-01T10:30:00Z",
    "lastPublishedDateTime": "2021-09-01T10:30:00Z",
    "lastEnabledDateTime": "2021-09-01T10:30:00Z",
    "lastDisabledDateTime": "2021-09-01T10:30:00Z",
    "lastSenderConsentDateTime": "2021-09-01T10:30:00Z",
    "publishedSlug": "a535041793dd266079763bbf1c965292"
  },
  "formProperties": {
    "name": "Patient Intake Forms",
    "isPrivateAccess": true,
    "allowSending": true
  },
  "formState": "active",
  "hasDraftChanges": true,
  "id": "00000000-0000-0000-0000-000000000000",
  "isEnabled": true,
  "isPublished": true,
  "isUploaded": true,
  "versionId": 1
}

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 a web form configuration.

If you make changes to an active form configuration, the unchanged active version will also be maintained. The two versions will have the same formId but different formState values. Use the state query parameter to indicate which version to return.

Required authentication scopes: signature, webforms_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 web form configuration.

Query parameters

stateenumOptionalDefaults to draft

The state of the web form configuration. Valid values:

active
draft

Allowed values:

Response

Web Form that represents a single active version with metadata

accountIdstringOptionalformat: "uuid"

Account identifier in which the webform resides

formContentobjectOptional

Container for the components map and future form data

formMetadataobjectOptional

Metadata for the web form.

formPropertiesobjectOptional

Properties of the web form configuration that are consistent across versions.

formStateenumOptional

The state of the form content

Allowed values:

hasDraftChangesbooleanOptional

When true, the web form configuration has changes that are not yet published.

idstringOptionalformat: "uuid"

Unique identifier for a webform entity that is consistent for it's lifetime

isEnabledbooleanOptional

When true, the web form configuration is activated. You can only create web form instances from enabled web forms.

isPublishedbooleanOptional

Whether the form is published (true or false).

isUploadedbooleanOptional

Indicates whether the form was created through an upload.

versionIdintegerOptional

Identifier for the version that can be used for display and retrieval in the API

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error