Pigeon
    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

    Authentication

    API Access#

    To gain access to the Pigeon API, you must be subscribed to a paid Pigeon API plan. Upon subscription, we'll provide a live API key which can be used to authenticate with the production API.

    API Authentication#

    The Pigeon API uses API keys to authenticate requests.
    To authenticate an API request, specify your API key in the X-API-KEY request header:
    All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
    Your API keys carry many privileges, so be sure to keep them secure. Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
    Modified at 2024-10-01 12:48:11
    Previous
    Introduction
    Next
    Integrations