Requests

Get Request

Fetch Request identified by ID.

get/requests/{id}

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/{id}
  • Auth: none declared

Path parameters

idstring required

Response

Successful Response

namestring required

Request name. Required unless templateId is set. In the case templateId is set, will use the default template title

idstring required
owner_idstring required

Identifier for request owner/manager

team_idstring required

Identifier for team that template is associated with

owner_openedboolean required

Whether request has been opened by owner

status'CLOSED' | 'INCOMPLETE' | 'COMPLETE' | 'EXPIRED' | 'VERIFIED' required
verifiedboolean required

Whether request has been verified by owner

deletedboolean required

Whether request has been deleted

rejectedboolean required

Whether recipient's submission has been rejected by owner

reminder_scheduleScheduledNotificationPublic[] required

Scheduled reminder notifications to be sent if the request is not completed.

escalationsScheduledNotificationPublic[] required

Scheduled escalation notifications to be sent if the request is not completed.

due_datestring date-time

Date when request must be completed by.

expiration_datestring date-time

Date when request and all submitted documents will be deleted. Must be greater than (later than) due date. Defaults to organizational settings.

auto_close_atstring date-time

Date when request will automatically close if not completed.

personal_messagestring

Custom message displayed to recipient when viewing the request. Overwrites template customMessage when set. Renders as HTML.

notesstring

Internal notes about request intended for owner and collaborator use. Notes are rendered as HTML on dashboard's View Request page.

user_metadataobject

JSON field used for storing additional, structured information with a request.

language'en-US' | 'es' | 'ar' | 'zh' | 'fr' | 'de' | 'ht' | 'he' | 'id' | 'it' | 'ko' | 'pt' | 'pa' | 'ru'
remindersstring

Interval for reminder notifications, in days. Default is 3. Valid values: null (no reminders) or ≥ 1.

first_reminder_datestring date-time

Optional date when the first reminder should be sent. If not set, reminders start based on request creation date + reminder interval. Must be a future date.

cloud_storage_folderstring

Path to folder in cloud storage provider where request documents will be stored.

cloud_storage_provider'PIGEON' | 'GOOGLE_DRIVE' | 'BOX' | 'DROPBOX' | 'AZURE' | 'ONENOTE' | 'DOCKETWISE' | 'CLIO'
require_complete_submissionboolean

When true, the request cannot be submitted until every required item is complete; partial submissions are blocked.

disable_submission_commentsboolean

When true, the Add Message option is hidden when the request is submitted.

user_openedboolean

Whether a recipient has opened the request

template_idstring

ID of Template used to create request

percent_completenumber

Completion percentage based on completion status of request's items

Changes

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