API overview
Read and write your companies, contacts, custom fields and lists, and send email, from your own servers.
The Pedibee API is a JSON REST API. Use it to sync your CRM, add sign-ups from your website as contacts, keep lists up to date, or send one-off emails from your Gmail.
Base URL
https://api.pedibee.com/api/v1Every path in this reference is relative to it. All requests use HTTPS.
Quick start
Create an API key
In Pedibee, open Settings → API keys and click Create API key. Give it a name, choose what it can read and change, and confirm with your password. Copy the key — it's shown once. See Authentication.
Keep it on your server
Store the key as an environment variable, e.g. PEDIBEE_API_KEY. Never put it in a browser, a mobile app or a public repository: requests sent from a browser are refused.
Make your first call
curl https://api.pedibee.com/api/v1/contacts?limit=5 \
-H "Authorization: Bearer $PEDIBEE_API_KEY"You get your five newest contacts:
{
"data": [
{ "id": "66f1c2a9e4b0a1b2c3d4e5f6", "email": "jane@northwind.io", "name": "Jane Cooper" }
],
"total": 1,
"skip": 0,
"limit": 5
}Conventions
- JSON in, JSON out. Send bodies with
Content-Type: application/json. Responses are JSON. - Ids are 24-character hex strings, returned as
id. - Dates are ISO 8601 in UTC, e.g.
2026-10-05T09:30:00.000Z. - Lists of results are
{ "data": [...], "total", "skip", "limit" }. Page withskipandlimit(up to 200). - Updates are partial:
PATCHchanges only the fields you send. - Errors are
{ "error": "A message you can show" }with a matching HTTP status. See Errors and limits. - Your workspace only. A key belongs to one workspace and never sees another's data.
Endpoints
Companies
/leadsList companiesPOST/leadsCreate a companyGET/leads/:idGet a companyPATCH/leads/:idUpdate a companyDELETE/leads/:idDelete a companyContacts
/contactsList contactsPOST/contactsCreate a contactGET/contacts/:idGet a contactPATCH/contacts/:idUpdate a contactDELETE/contacts/:idDelete a contactCustom fields
/contact-fieldsList custom fieldsPOST/contact-fieldsCreate a custom fieldPATCH/contact-fields/:idUpdate a custom fieldDELETE/contact-fields/:idDelete a custom fieldLists
/listsList listsPOST/listsCreate a listGET/lists/:idGet a listPATCH/lists/:idUpdate a listDELETE/lists/:idDelete a listPOST/lists/:id/contactsAdd people to a listDELETE/lists/:id/contactsRemove people from a listEmails
AI assistants
The same operations are tools on the MCP server, so Claude, ChatGPT, Cursor and other assistants can work in your workspace — you connect them with your Pedibee account, no API key needed.