Search the docs

Find a page, a section, or an endpoint.

Sign inStart for free

API reference

Every endpoint, generated from the OpenAPI document the API publishes — so it cannot describe an endpoint that does not exist. The base path is /api/v1, and every request carries Authorization: Bearer $PIDGEON_API_KEY.

Addresses25 endpointsAgent cards1 endpointAgent signup5 endpointsAPI keys6 endpointsApp passwords3 endpointsAttachments5 endpointsCard log8 endpointsContacts7 endpointsDeliveries2 endpointsDomains8 endpointsDrafts10 endpointsEvents4 endpointsExport1 endpointFolders4 endpointsFree time1 endpointGrant templates3 endpointsGrants5 endpointsLabels4 endpointsMessages14 endpointsMetrics1 endpointPods5 endpointsRouting rules4 endpointsSign in with Pidgeon1 endpointTenants1 endpointTest mode1 endpointThis key1 endpointThreads6 endpointsVerify a sender1 endpointWebhooks7 endpointsWorkspace2 endpoints