Pigeon // E-Sign
  1. Document Generation
Pigeon // E-Sign
  • Introduction
  • Authentication
  • Integrations
  • Documents
    • List Documents
      GET
    • Create Document
      POST
    • Get Document Status
      GET
    • Delete Document
      DELETE
    • Update Document
      PATCH
    • Update Document Status
      PATCH
    • Move Document to Draft
      POST
    • Get Document Details
      GET
    • Send Document
      POST
    • Create Document Session
      POST
    • Download Document
      GET
    • Download Protected Document
      GET
    • Update Document Ownership
      PATCH
    • Transfer Documents Ownership
      PATCH
  • Document Attachments
    • Document Attachment List
      GET
    • Document Attachment Create
      POST
    • Document Attachment Details
      GET
    • Document Attachment Delete
      DELETE
    • Document Attachment Download
      GET
  • Document Generation
    • List Document Fields
      GET
    • Create Document Fields
      POST
  • Document Recipients
    • Add Document Recipient
      POST
    • Edit Document Recipient
      PATCH
    • Delete Document Recipient
      DELETE
    • Reassign Document Recipient
      POST
  • Bulk Send
    • Trigger Bulk Send
    • Create Bulk Send List
    • Get Bulk Send List
    • Get Bulk Send Lists
    • Update Bulk Send List
    • Delete Bulk Send List
  • Templates
    • List Templates
    • Create Template
    • Template Details
    • Delete Template
  • Cloud Storage
    • List Cloud Storage Providers
    • Connect Cloud Storage Providers
    • Disconnect Cloud Storage Provider
  • Webhooks
    • Get all webhook subscriptions
    • Create webhook subscription
    • Get webhook subscription by uuid
    • Update webhook subscription
    • Delete webhook subscription
  • Branding
    • Get Organization Branding
    • Update Organization Branding
  • Confirmation Page
    • Enable/Disable Signature Confirmation Page
  1. Document Generation

List Document Fields

GET
/documents/{id}/fields
Return the list of fields for a particular document

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 '/documents/BhVzRcxH9Z2LgfPPGXFUBa/fields'

Responses

🟢200OK
application/json
OK
Body

Example
{
    "fields": [
        {
            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
            "name": "string",
            "title": "string",
            "value": "string",
            "field_id": "string",
            "type": "text",
            "placeholder": "string",
            "assigned_to": {
                "id": "string",
                "first_name": "string",
                "last_name": "string",
                "email": "string",
                "phone": "string",
                "recipient_type": "string",
                "has_completed": true,
                "signing_order": "string",
                "delivery_methods": "string",
                "redirect": "string",
                "type": "string"
            },
            "layout": {},
            "section_uuid": "c2428533-c3ca-4d82-b2a9-8f56ee0f1ca4"
        }
    ]
}
🟠401Unauthorized
🟠404Record Not Found
🟠409409
🟠429429
Modified at 2024-09-17 17:05:10
Previous
Document Attachment Download
Next
Create Document Fields