Pigeon
  1. Documents
Pigeon
  • Introduction
  • Authentication
  • Integrations
  • Webhooks
  • Guides
    • How To Share Files via Pigeon
    • How To Create an E-Signature Request Item
    • How To Send Emails from Organization Addresses
  • Requests
    • Create Request
      POST
    • List Requests
      GET
    • Get Request
      GET
    • Delete Request
      DELETE
    • Update Request
      PATCH
    • Verify Request
      POST
    • Close Request
      POST
    • Duplicate Request
      POST
    • Reject Request (Request Changes)
      POST
    • Send Request Reminder
      POST
    • List Request Reminders
      GET
    • Get Request Activity Log
      GET
    • List Organization Requests
      GET
    • Update Request
      PATCH
    • Delete Request
      DELETE
  • Request Items
    • List Request Items
    • Get Request Item
    • Verify Request Item
    • Update Request Item
    • Delete Request Item
    • Create Request Item
  • Templates
    • Create Template
    • List Templates
    • Get Template
    • Delete Template
    • Update Template
    • List Organization Templates
  • Webhooks
    • Create Webhook Subscription
    • Get Webhook Subscription
    • List Webhook Subscriptions
    • Update Webhook Subscription
    • Delete Webhook Subscription
  • Files
    • Download Request Files
    • Download Request Item Files
    • Download File
    • Get Request Files
    • Get Request Item Files
    • Delete File
  • Request Attachments
    • Upload Attachment
    • List Item Attachments
    • Get Attachment
    • Download Attachment
    • Delete Attachment
  • File Sharing
    • Initialize File Sharing Session
    • Upload File
    • Share Files
    • List File Sharing Sessions
    • Get File Sharing Session
    • Update File Sharing Session
    • Delete File Sharing Session
  • E-Signature / Document Forms
    • Create New E-Signature Document
    • Update E-Signature Document
    • Get E-Signature Document
    • List E-Signature Documents
    • Delete E-Signature Document
  • Users
    • List Users
    • Get User
    • Get Current User
  • Cloud Storage
    • List Cloud Storage Providers
    • Connect Cloud Storage Providers
    • Disconnect Cloud Storage Provider
  • Branding
    • Get Organization Branding
    • Update Organization Branding
  • Confirmation Page
    • Enable/Disable Signature Confirmation Page
  • Organization
    • Get Organization Settings
    • Update Organization Settings
  • RequestItems
    • Create Request Item
    • List Request Items
    • Get Request Item
    • Update Request Item
    • Delete Request Item
    • Verify Request Item
  • Documents
    • Get Document
      GET
    • Delete Document
      DELETE
    • List Request Documents
      GET
    • Delete Request Documents
      DELETE
    • List Request Item Documents
      GET
    • Download Document
      GET
    • Download Request Documents
      GET
    • Download Request Item Documents
      GET
  1. Documents

List Request Documents

GET
/requests/{request_id}/documents
Documents
Retrieve a list of documents submitted for a request.

Request

Path Params
request_id
string 
required

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/requests//documents'

Responses

🟢200OK
application/json
Successful Response
Body
array of:
name
string 
required
Document name
type
enum<string> 
required
Item type document was submitted for
Allowed values:
FILEE_SIGNATUREQUESTION
id
string 
required
creation_date
string <date-time>
required
Document creation timestamp
item_id
string 
required
ID of Request Item document was submitted for
item_name
string 
required
Name of Request Item document was submitted for
size
integer 
optional
Document size in bytes
recipient_id
string 
optional
ID of recipient who submitted document
completed
boolean 
optional
Indicates whether a document has been completed. Only applies to documents where type: E_SIGNATURE.
Example
[
    {
        "name": "string",
        "type": "FILE",
        "id": "string",
        "creation_date": "2019-08-24T14:15:22Z",
        "item_id": "string",
        "item_name": "string",
        "size": 0,
        "recipient_id": "string",
        "completed": true
    }
]
🟠404Record Not Found
🟠422Parameter Error
Modified at 2025-02-11 06:40:21
Previous
Delete Document
Next
Delete Request Documents