Pigeon
  1. E-Signature / Document Forms
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
      POST
    • Update E-Signature Document
      PATCH
    • Get E-Signature Document
      GET
    • List E-Signature Documents
      GET
    • Delete E-Signature Document
      DELETE
  • 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. E-Signature / Document Forms

Get E-Signature Document

GET
/contracts/{id}
Fetch an e-signature document

Request

Path Params
id
string 
required
ID

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 '/contracts/'

Responses

🟢200Success
application/json
Body
document
object (File) 
required
Document requiring e-signature
id
string 
required
ID
name
string 
required
File name
mime
string 
required
File MIME type
annotationUrl
string <uri>
required
Open this URL in a browser to load an interactive session for adding/updating fields and annotations to document.
annotations
array[object (ContractAnnotation) {4}] 
optional
Dynamic fields to be displayed in document during signing session
id
string 
optional
ID
type
enum<string> 
required
Type of annotation
Allowed values:
stringnumberdate
defaultValue
string 
optional
Default value to be displayed if annotation not overwritten.
layout
object (ContractItemLayout) 
optional
Layout details for annotation placement in document.
fields
array[object (ContractFields) {5}] 
optional
Fields that need to be filled in by signer
id
string 
optional
ID
type
enum<string> 
required
Field/input type
Allowed values:
textsignaturecheckboxradioinitialsdate
placeholder
string 
optional
Placeholder value to be displayed until field receives input.
assigned_to
object (Assignee) 
optional
Recipient who the field is assigned to
layout
object (ContractItemLayout) 
optional
Layout details for field placement in document.
Example
{
    "document": {
        "id": "f9c28ddb-58c8-4dd8-94ff-96d5ece6f388",
        "name": "Contract.pdf",
        "mime": "application/pdf"
    },
    "annotationUrl": "https://app.pigeondocuments.com/doc/xzvcxjdsf2341masf134kadsf",
    "annotations": [
        {
            "type": "number",
            "defaultValue": "incididunt laborum dolor commodo eiusmod",
            "layout": {
                "page": 0,
                "position": {
                    "offset_x": -84988637.08515118,
                    "offset_y": 76221383.79903123,
                    "anchor_point": "BOTTOM_RIGHT"
                },
                "style": {
                    "width": -67854076,
                    "height": -51605028
                }
            }
        },
        {
            "type": "date",
            "defaultValue": "enim laborum",
            "layout": {
                "page": 0,
                "position": {
                    "offset_x": 16726.95197480917,
                    "offset_y": 33020050.930892617,
                    "anchor_point": "BOTTOM_LEFT"
                },
                "style": {
                    "width": 3261161,
                    "height": -6514483
                }
            }
        }
    ],
    "fields": [
        {
            "type": "radio",
            "placeholder": "voluptate consectetur in Duis",
            "assigned_to": {
                "email": "Richmond_Franecki@gmail.com",
                "firstName": "Hector",
                "lastName": "Daniel"
            },
            "layout": {
                "page": 0,
                "position": {
                    "offset_x": 75107719.20316532,
                    "offset_y": 94359924.66340962,
                    "anchor_point": "BOTTOM_LEFT"
                },
                "style": {
                    "width": -43734081,
                    "height": 11141666
                }
            }
        },
        {
            "type": "date",
            "placeholder": "dolor proident",
            "assigned_to": {
                "email": "Alfreda_King29@hotmail.com",
                "firstName": "Adrianna",
                "lastName": "Zieme"
            },
            "layout": {
                "page": 0,
                "position": {
                    "offset_x": -75711551.97874656,
                    "offset_y": -45913256.760643154,
                    "anchor_point": "BOTTOM_LEFT"
                },
                "style": {
                    "width": -53180974,
                    "height": 89574610
                }
            }
        },
        {
            "type": "signature",
            "placeholder": "sit ea",
            "assigned_to": {
                "email": "Skylar72@yahoo.com",
                "firstName": "Sonia",
                "lastName": "Abshire-Corkery"
            },
            "layout": {
                "page": 0,
                "position": {
                    "offset_x": -54900761.57052841,
                    "offset_y": 73773090.60829598,
                    "anchor_point": "BOTTOM_RIGHT"
                },
                "style": {
                    "width": -55350048,
                    "height": 28867818
                }
            }
        }
    ]
}
🟠404Record Not Found
Modified at 2024-10-29 16:11:43
Previous
Update E-Signature Document
Next
List E-Signature Documents