List forms.

GET https://aws.consentgrid.io/v1/esign/form?query

The query can contain the following fields:

party.type, party.id
Search by a signer party. If the party.type is not given, user is assumed.
by.type, by.id
Search by the form creator user. If the by.type is not given, user is assumed.
status
Comma separated list of statuses. Can include draft, published, completed, and canceled.
from
0-based offset in the result set to start listing.
max
Maximum number of forms to return. The maximum is 100.

Response

200 Ok
{
  "total": 10,
  "forms": [
   {
     "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.