Documents

List Request Documents

Retrieve a list of documents submitted for a request.

get/requests/{request_id}/documents

Request

  • Base URL: https://api.pigeondocuments.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pigeondocuments.com/requests/{request_id}/documents
  • Auth: none declared

Path parameters

request_idstring required

Response

Successful Response

namestring required

Document name

type'FILE' | 'E_SIGNATURE' | 'QUESTION' required
idstring required
creation_datestring date-time required

Document creation timestamp

item_idstring required

ID of Request Item document was submitted for

item_namestring required

Name of Request Item document was submitted for

sizeinteger

Document size in bytes

recipient_idstring

ID of recipient who submitted document

data_linkstring

For documents stored outside of Pigeon, the URL where the document is available for access.

completedboolean

Indicates whether a document has been completed. Only applies to documents where type: E_SIGNATURE.

extracted_metadataobject

Extracted metadata from the document

Changes

No recorded changes to this operation across all 1 revision of this API.