REST API
Everything you can do in the dashboard, you can do with the API. Build integrations, automate workflows, or connect Pigeon Perch to your own systems.
Authentication
Two ways to authenticate:
- API Key: create one in your dashboard under API → API Keys, then pass it as
X-API-Key: your-key-here. - Bearer Token: use a Clerk JWT in the
Authorization: Bearer your-tokenheader. This is what the frontend uses.
Base URL
https://your-domain.com/api/v1/
Common Endpoints
Contacts
GET /contacts
POST /contacts
POST /contacts/import
PATCH /contacts/:id
DELETE /contacts/:id
Campaigns
GET /campaigns
POST /campaigns
POST /campaigns/:id/send
POST /campaigns/:id/schedule
Products
GET /listings
POST /listings
POST /listings/import
POST /listings/sync/shopify
POST /listings/sync/webhook
POST /listings/sync/feed
Suppression Groups
GET /suppression-groups
POST /suppression-groups
PATCH /suppression-groups/:id
DELETE /suppression-groups/:id
Full Reference
The interactive API explorer lives in your dashboard under API → Endpoints. It shows every endpoint with request and response examples.