Search the docs
Find a page, a section, or an endpoint.
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.
Addresses24 endpointsAgent signup3 endpointsAPI keys6 endpointsApp passwords3 endpointsAttachments3 endpointsDeliveries2 endpointsDomains8 endpointsDrafts9 endpointsEvents4 endpointsExport1 endpointLabels4 endpointsMailboxes4 endpointsMessages13 endpointsMetrics1 endpointPods4 endpointsRouting rules4 endpointsTenants1 endpointTest mode1 endpointThis key1 endpointThreads6 endpointsWebhooks7 endpointsWorkspace2 endpoints