Pigeon API // Staging
  1. Requests
Pigeon API // Staging
  • Introduction
  • Authentication
  • Integrations
  • Guides
    • Using Third-Party Cloud Storage
  • Requests
    • Requests
    • Create Request
      POST
    • List Requests
      GET
    • Get Request
      GET
    • List Organization Requests
      GET
    • Update Request
      PATCH
    • Delete Request
      DELETE
  • Documents
    • 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
  • Templates
    • Templates
    • List Templates
      GET
    • Create Template
      POST
    • Get Template
      GET
    • Update Template
      PATCH
    • Delete Template
      DELETE
    • List Organization Templates
      GET
  • RequestItems
    • Request Items
    • Create Request Item
    • List Request Items
    • Get Request Item
    • Update Request Item
    • Delete Request Item
    • Verify Request Item
  • Webhooks
    • Webhooks
    • Create Webhook Subscription
    • List Webhook Subscriptions
    • Get Webhook Subscription
    • Update Webhook Subscription
    • Delete Webhook Subscription
    • Get Webhook Signing Secret
  • Users
    • Get Current User
    • List Users
    • List Organization users
  • Contacts
    • List Contacts
    • Create or Update Contact
    • List Organization Contacts
  • Teams
    • List Teams
    • Get Team
  • Schemas
    • Schemas
      • CreateAuthMethod
      • CreateQuestionItem
      • RequestState
      • ResourceNotFoundModel
      • StorageProviders
      • SessionPayload
      • TEMPLATENotFoundModel
      • TEMPLATENotFoundModel
      • ORGANIZATIONNotFoundModel
      • ORGANIZATIONNotFoundModel
    • AuthMethod
    • CollaboratorPublic
    • CreateRecipientPostParams
    • ConnectionProvider
    • CreateRequestItem
    • CreateRequestPostParams
    • CreateRequestRecipient
    • CreateTemplatePostParams
    • CreateWebhookWithoutOrg
    • HTTPValidationError
    • DocumentNotFound
    • ItemType
    • DocumentPublic
    • FilenameFormat
    • RequestItemPublic
    • OrganizationNotFound
    • DocumentType
    • DocumentWithItemPublic
    • RequestPublic
    • RequestItemNotFound
    • RequestRecipientPublic
    • RequestNotFound
    • Language
    • RequestStatus
    • SendMethod
    • TemplatePublic
    • SortOrder
    • SessionPayloadPublic
    • TemplateNotFound
    • RecipientPublic
    • UpdateRequestItem
    • TeamNotFound
    • UpdateRequestPostParams
    • TeamPublic
    • UpdateTemplate
    • UpdateWebhook
    • UserRole
    • ValidationError
    • WebhookPublic
    • WebhookTopic
    • WebhookPublicWithSecret
    • WebhookNotFound
    • UserPublic
  1. Requests

Get Request

GET
/requests/{id}
Fetch Request identified by ID.

Request

Path Params

Request Code 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/'

Responses

🟢200OK
application/json
Successful Response
Body

Example
{
    "name": "string",
    "items": [
        {
            "name": "string",
            "id": "string",
            "type": "UPLOAD",
            "description": "string",
            "required": true,
            "answer": "string",
            "verified": false,
            "is_na": false
        }
    ],
    "recipients": [
        {
            "request_link": "string",
            "mfa_link": "string",
            "auth": "NONE",
            "password": "string",
            "recipient": {
                "id": "string",
                "first_name": "string",
                "last_name": "string",
                "email": "string",
                "phone": "string",
                "owner_id": "string",
                "team_id": "string",
                "language": "en-US"
            }
        }
    ],
    "id": "string",
    "owner_id": "string",
    "team_id": "string",
    "owner_opened": true,
    "status": "CLOSED",
    "verified": true,
    "deleted": true,
    "rejected": true,
    "due_date": "2019-08-24T14:15:22.123Z",
    "expiration_date": "2019-08-24T14:15:22.123Z",
    "personal_message": "string",
    "notes": "string",
    "user_metadata": {
        "property1": "string",
        "property2": "string"
    },
    "language": "en-US",
    "reminders": "-1",
    "first_reminder_date": "2019-08-24T14:15:22.123Z",
    "collaborators": [],
    "cloud_storage_folder": "string",
    "cloud_storage_provider": "PIGEON",
    "user_opened": false,
    "template_id": "string",
    "percent_complete": 0,
    "property1": "string",
    "property2": "string"
}
🟠404Not Found
🟠422Unprocessable Entity
Modified at 2026-01-15 05:36:49
Previous
List Requests
Next
List Organization Requests
Built with