Pigeon API // Staging
    • Introduction
    • Authentication
    • Integrations
    • 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
      • Close Request
        POST
    • 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
      • Get User
    • Contacts
      • List Contacts
      • Create or Update Contact
      • List Organization Contacts
    • Teams
      • List Teams
      • Get Team
    • ScheduledReminders
      • Create Scheduled Reminder
      • List Scheduled Reminders
      • Get Scheduled Reminder
      • Update Scheduled Reminder
      • Delete Scheduled Reminder
    • Attachments
      • List Attachments
      • Create Attachment
      • Get Attachment
    • Escalations
      • Create Escalations
      • List Escalations
      • Get Escalation
      • Update Escalation
      • Delete Escalation
    • Forms
      • Get Form
      • Delete Form
      • List Forms
      • Create Form
    • Schemas
      • AuthMethod
      • Body_handler_attachments_post
      • Body_handler_forms_post
      • ButtonStyle
      • CollaboratorPublic
      • ConnectionProvider
      • CreateDocGen
      • CreateESignatureObject
      • CreateEscalation
      • CreateQuestionObject
      • CreateRecipientPostParams
      • CreateRequestItem
      • CreateRequestPostParams
      • CreateRequestRecipient
      • CreateScheduledNotificationRecipient
      • CreateScheduledReminder
      • CreateTemplatePostParams
      • CreateWebhookWithoutOrg
      • CustomerDocumentPublic
      • DocumentNotFound
      • DocumentPublic
      • DocumentType
      • DocumentWithItemPublic
      • FilenameFormat
      • FormFieldPublic
      • FormFieldType
      • FormNotFound
      • FormPublic
      • HTTPValidationError
      • HeroStyle
      • ItemType
      • Language
      • OrganizationNotFound
      • QuestionType
      • RecipientPublic
      • RequestAttachmentPublic
      • RequestItemNotFound
      • RequestItemPublic
      • RequestNotFound
      • RequestPublic
      • RequestRecipientPublic
      • RequestStatus
      • ScheduledNotificationNotFound
      • ScheduledNotificationPublic
      • SendMethod
      • SessionPayloadPublic
      • SortOrder
      • TeamNotFound
      • TeamPublic
      • TemplateNotFound
      • TemplatePublic
      • UpdateEscalation
      • UpdateRequestItem
      • UpdateRequestPostParams
      • UpdateScheduledNotificationRecipient
      • UpdateScheduledReminder
      • UpdateTemplate
      • UpdateWebhook
      • UserNotFound
      • UserPublic
      • UserRole
      • ValidationError
      • WebhookNotFound
      • WebhookPublic
      • WebhookPublicWithSecret
      • WebhookTopic

    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 2026-01-07 19:59:36
    Previous
    Introduction
    Next
    Integrations
    Built with