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

List Organization Requests

GET
/organizations/{org_id}/requests
Requests
Retrieve a list of requests associated with the specified organization.

Request

Path Params
org_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 '/organizations//requests'

Responses

🟢200OK
application/json
Successful Response
Body
array of:
name
string 
required
Request name. Required unless templateId is set
items
array[object (RequestItemPublic) {6}] 
required
Items included in the request. Required unless templateId is set. Overwrites template items when set.
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
recipients
array[object (RequestRecipientPublic) {4}] 
required
Users receiving the request
request_link
string 
required
auth
enum<string> 
required
Allowed values:
UNSETEMAILSMSSECURITY_QUESTIONNONE
password
string 
required
recipient
object (RecipientPublic) 
required
id
string 
required
state
enum<string> 
required
Current request state
Allowed values:
PRE_LINK_GENERATEDINCOMPLETE_AND_FRESHLY_GENERATEDINCOMPLETE_AND_LINK_GENERATEDINCOMPLETE_AND_LINK_SENTPARTIALLY_SUBMITTEDREJECTEDSUBMITTEDUPDATED_AND_SUBMITTEDEXPIRATION_EMAIL_SENTCOMPLETE_AND_SUBMITTEDVERIFIEDEXPIREDCLOSED
owner_id
string 
required
Identifier for request owner/manager
owner_opened
boolean 
required
Whether request has been opened by owner
user_opened
boolean 
required
Whether a recipient has opened the request
due_date
string <date-time>
optional
Date when request must be completed by.
expiration_date
string <date-time>
optional
Date when request and all submitted documents will be deleted. Must be greater than (later than) due date. Defaults to organizational settings.
personal_message
string 
optional
Custom message displayed to recipient when viewing the request. Overwrites template customMessage when set.
language
enum<string> 
optional
Defaults to English (en).
Allowed values:
en-USesarzhfrdehtheiditkoptparu
reminders
string 
optional
Interval at which recipients will receive reminder notifications to complete request, measured in days. The default value is three (3) days.
Default:
-1
collaborators
array[object (CollaboratorPublic) {5}] 
optional
Collaborators receive email updates related to request lifecycle and have limited edit access to the request.
id
string 
required
role
enum<string> 
required
Allowed values:
ADMINUSER
first_name
string 
optional
last_name
string 
optional
email
string 
optional
template_id
string 
optional
ID of Template used to create request
Additional properties
integer  | number  | string  | boolean 
optional
Example
[
  {
    "name": "string",
    "items": [
      {
        "name": "string",
        "id": "string",
        "type": "UPLOAD",
        "description": "string",
        "required": true,
        "answer": "string"
      }
    ],
    "recipients": [
      {
        "request_link": "string",
        "auth": "UNSET",
        "password": "string",
        "recipient": {
          "email": "string",
          "first_name": "string",
          "last_name": "string",
          "phone": "string"
        }
      }
    ],
    "id": "string",
    "state": "PRE_LINK_GENERATED",
    "owner_id": "string",
    "owner_opened": true,
    "user_opened": true,
    "due_date": "2019-08-24T14:15:22Z",
    "expiration_date": "2019-08-24T14:15:22Z",
    "personal_message": "string",
    "language": "en-US",
    "reminders": "-1",
    "collaborators": [],
    "template_id": "string"
  }
]
🟠404Record Not Found
🟠422Parameter Error
Modified at 2025-02-11 06:40:21
Previous
Get Request Activity Log
Next
Update Request