Read a form.

GET https://aws.consentgrid.io/v1/esign/form/{formId}

This API loads and returns a form by its ID.

Response

200 Ok
{
  "parties": [
    {
      "role": "signer",
      "required": true,
      "id": {
        "type": "user",
        "id": "12874-8488297-439834"
      }
    },
    ...
  ],
  "minOptional": 2,
  "completeWhen": "signed",
  "dateRange": {
    "from": "2006-01-02T15:04:05Z07:00",
    "to": "2006-01-02T15:04:05Z07:00"
  },
  "data": {...},
  "uiData": {...},
  "template": {
    "name": "templateName",
    "locale": "en"
  },
  "by": {
    "type": "user",
    "id": "123-34345"
  }     
}
400 Bad Request

Malformed request, invalid value, etc. The return value is a JSON error object containing diagnostic information.

403 Forbidden

The authenticated key does not have the privileges for this operation. The return value is a JSON error object containing diagnostic information.

404 Not Found

Form not found.