Pigeon
  1. RequestItems
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
      POST
    • List Request Items
      GET
    • Get Request Item
      GET
    • Update Request Item
      PATCH
    • Delete Request Item
      DELETE
    • Verify Request Item
      POST
  • Documents
    • Get Document
    • Delete Document
    • List Request Documents
    • Delete Request Documents
    • List Request Item Documents
    • Download Document
    • Download Request Documents
    • Download Request Item Documents
  1. RequestItems

List Request Items

GET
/requests/{request_id}/items
RequestItems
Retrieve list of items associated with 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//items'

Responses

🟢200OK
application/json
Successful Response
Body
array of:
name
string 
required
Item name. For items with type: Question, the name is used as the question text.
id
string 
required
type
enum<string> 
required
Type of the request item
Allowed values:
UPLOADE_SIGNATUREQUESTION
description
string 
optional
Item description
required
boolean 
optional
Indicates whether the recipient is required to complete the request item
answer
string 
optional
Question answer. Only applies to items with type: QUESTION
Example
[
  {
    "name": "string",
    "id": "string",
    "type": "UPLOAD",
    "description": "string",
    "required": true,
    "answer": "string"
  }
]
🟠404Record Not Found
🟠422Parameter Error
Modified at 2025-02-11 06:40:21
Previous
Create Request Item
Next
Get Request Item