LogoSignature Service
REST APISigning requests

List all signing requests

GET
/admin/api/v3/organizations/{organizationId}/rooms/{signingRoomId}/requests

Authorization

basicAuth
AuthorizationBasic <token>

In: header

Path Parameters

organizationId*string
signingRoomId*string

Query Parameters

searchQuery?string

Search query to filter signing requests by signatory (firstname, lastname, email) or document name

state?string

Filter by state

signatoryId?string

Filter by signatory id

page?integer

Zero-based page index (0..N)

Formatint32
Default0
size?integer

The size of the page to be returned

Formatint32
Default2000
sortBy?string

Sort By

Default"lastModifiedAt"

Value in

  • "lastModifiedAt"
  • "createdAt"
  • "state"
sortDirection?string

Sort direction

Default"DESC"

Value in

  • "ASC"
  • "DESC"

Response Body

application/json

curl -X GET "https://example.com/admin/api/v3/organizations/string/rooms/string/requests"
{  "content": [    {      "auditTrailAvailable": true,      "canceledAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "createdBy": {        "displayName": "string"      },      "deliveryOptions": {        "recipients": [          {            "email": "string",            "locale": "string"          }        ]      },      "documents": [        {          "id": "string",          "payloadSigned": true,          "payloadType": "PDF",          "responses": [            {              "decision": "ACCEPTED",              "id": "string",              "payloadSigned": true,              "rejectionMessage": "string",              "repliedAt": "2019-08-24T14:15:22Z",              "signatory": {                "displayName": "string",                "email": "string",                "firstname": "string",                "id": "string",                "lastname": "string",                "locale": "string",                "manager": true,                "phoneNumber": "string",                "signatoryAttributes": [                  {                    "displayName": "string",                    "key": "string",                    "required": true,                    "value": "string"                  }                ],                "signingRoomPermission": "SIGNATORY",                "username": "string"              }            }          ],          "thumbnail": "string",          "title": "string"        }      ],      "expiresAt": "2019-08-24T14:15:22Z",      "id": "string",      "lastModifiedAt": "2019-08-24T14:15:22Z",      "message": "string",      "retainedUntil": "2019-08-24T14:15:22Z",      "signatories": [        {          "displayName": "string",          "email": "string",          "firstname": "string",          "id": "string",          "lastname": "string",          "locale": "string",          "manager": true,          "phoneNumber": "string",          "signatoryAttributes": [            {              "displayName": "string",              "key": "string",              "required": true,              "value": "string"            }          ],          "signingRoomPermission": "SIGNATORY",          "username": "string"        }      ],      "signingOrder": "SEQUENTIAL",      "state": "PENDING",      "workflow": {        "deliveryOptions": {          "allowManagerToAddRecipients": true,          "domainNames": [            "string"          ],          "sendSigningReportToAllManager": true        },        "description": "string",        "electronicSeal": true,        "enabledByDefault": true,        "id": "string",        "identification": true,        "name": "string",        "preassignedSignatories": {          "allowEdition": true,          "signatories": [            {              "email": "string",              "locale": "string"            }          ]        },        "smartContractIdentifier": "string"      }    }  ],  "empty": true,  "first": true,  "last": true,  "number": 0,  "numberOfElements": 0,  "pageable": {    "offset": 0,    "pageNumber": 0,    "pageSize": 0,    "paged": true,    "sort": {      "empty": true,      "sorted": true,      "unsorted": true    },    "unpaged": true  },  "size": 0,  "sort": {    "empty": true,    "sorted": true,    "unsorted": true  },  "totalElements": 0,  "totalPages": 0}

Retrieve the signed payload of a signing request GET

This API can be used to download the signed payload of the request. In case of a single document request, this API is equivalent to the API to document a document. For multiple documents requests, all signed documents will be compressed in a ZIP file.

Send reminder notification for a pending signing request POST

Next Page