# Docs

- Guides: Using Pedibee
  - [Welcome](/docs): Pedibee is a sales workspace for companies, the people at them, and every email you send them from your own Gmail.
  - [Getting started](/docs/getting-started): From sign-up to your first email in about ten minutes.
  - [How Pedibee is organised](/docs/concepts): The handful of things everything else is built on: companies, contacts, stages, lists, and the outreach history.

  - **Your workspace**
  - [Companies](/docs/workspace/companies): The businesses you sell to, with their people, status, owner and everything you've sent them.
  - [Contacts](/docs/workspace/contacts): The people you email, one per address, with a stage, a company and their whole history.
  - [Lists](/docs/workspace/lists): Hand-picked groups of contacts, the audience for campaigns and sequences.
  - [Custom fields](/docs/workspace/custom-fields): Your own fields on contacts (plan, seats, renewal date, anything), usable in emails and automations.
  - [Importing companies and contacts](/docs/workspace/imports): Bring in a spreadsheet of companies and people, CSV or Excel, and map its columns.

  - **Email content**
  - [Templates and the email builder](/docs/content/templates): Reusable emails you build from blocks or write in HTML, and what happens when a campaign uses one.
  - [Signatures](/docs/content/signatures): Named email signatures, one of them the default, joined to every email when it's sent.
  - [Merge tags](/docs/content/merge-tags): Personalise the subject, preview text and body for each person, with fallbacks for missing data.
  - [The inbox check](/docs/content/inbox-check): What the editors warn about before you send, and why each thing matters to spam filters.

  - **Sending**
  - [Sending with Gmail](/docs/sending/gmail): Connect one or more Google Workspace accounts, and know what Pedibee can and can't do with them.
  - [Campaigns](/docs/sending/campaigns): One email, personalised for each person, sent one at a time from your Gmail.
  - [Sequences](/docs/sending/sequences): A series of emails over days, per person, that stops when they reply.
  - [One-off and scheduled emails](/docs/sending/one-off-emails): Email one person from your Gmail now or at a set time, and log the touches that happened elsewhere.
  - [Unsubscribes and the do-not-email list](/docs/sending/unsubscribes): Every email carries an unsubscribe link. Who used it, how to add people yourself, and how to see the totals.
  - [Limits and pacing](/docs/sending/limits-and-pacing): How much each Gmail sends per day, how Pedibee spaces emails out, and what happens at the limit.

  - **Deliverability**
  - [Email tracking](/docs/sending/email-tracking): See who opens your emails and which links they click, tracked through your own domain.
  - [Warm-up](/docs/deliverability/warm-up): Start a new Gmail account slowly, so your real emails land in the inbox.
  - [Email verification](/docs/deliverability/email-verification): Check that addresses exist before you email them, so bounces stay low and your sender reputation stays intact.
  - [Domain health and Gmail reputation](/docs/deliverability/domain-health): Check your sending domain's SPF, DKIM, DMARC and blocklists, and see what Google thinks of it.

  - **Automations**
  - [Automations](/docs/automations/automations): Emails and actions that start when something happens in your product.
  - [Sending events](/docs/automations/events): Tell Pedibee what people do in your product.
  - [Incoming webhooks](/docs/automations/webhooks): Turn any app's webhook into events, without code.
  - [Stripe and Paddle](/docs/automations/stripe-paddle): Start automations from payments and subscriptions.

  - **Team & settings**
  - [Team and roles](/docs/settings/team-and-roles): Invite people to a workspace as managers or members, and what each role can do.
  - [Workspaces](/docs/settings/workspaces): One workspace per product or company you sell; switch between them, rename or delete one.
  - [Your account](/docs/settings/account): Your name, how you sign in, passwords, and signing out everywhere.
  - [API keys and connected apps](/docs/settings/api-keys-and-apps): Let your own servers, or an AI assistant like Claude or ChatGPT, work in your workspace.

  - **Help**
  - [Troubleshooting](/docs/troubleshooting): What to check when something didn't send, didn't track, or didn't connect.
  - [FAQ](/docs/faq): Short answers to the questions we hear most.
- API reference: Build on Pedibee from your own servers
  - [API overview](/docs/api): Read and write your companies, contacts, custom fields and lists, and send email, from your own servers.
  - [Authentication](/docs/api/authentication): API keys, what each one may do, and keeping them safe.
  - [Common tasks](/docs/api/recipes): The things most teams build first, each in a few calls.
  - [Errors and limits](/docs/api/errors): Status codes, error messages, rate limits and paging.

  - **AI assistants**
  - [MCP & AI agents](/docs/mcp)

  - **Resources**
  - Companies
    - [Companies](/docs/api/companies): The companies you sell to, called leads in the API.
    - [List companies](/docs/api/companies/list): Your companies, newest first, with how many people each has.
    - [Create a company](/docs/api/companies/create): Add a company together with at least one person who works there.
    - [Get a company](/docs/api/companies/get): One company, with the people who work there.
    - [Update a company](/docs/api/companies/update): Change a company's details. Send only what changes.
    - [Delete a company](/docs/api/companies/delete): Delete a company, and choose what happens to its people.
  - Contacts
    - [Contacts](/docs/api/contacts): The people you email, at a company or on their own.
    - [List contacts](/docs/api/contacts/list): Your contacts, newest first, filtered by text, stage, company or list.
    - [Create a contact](/docs/api/contacts/create): Add one person by email address.
    - [Get a contact](/docs/api/contacts/get): One contact by id.
    - [Update a contact](/docs/api/contacts/update): Change a contact. Send only what changes.
    - [Delete a contact](/docs/api/contacts/delete): Delete a contact and their outreach history.
  - Custom fields
    - [Custom fields](/docs/api/custom-fields): Add your own fields to contacts, in the dashboard or through the API, and fill them in.
    - [List custom fields](/docs/api/custom-fields/list): Your workspace's custom contact fields and their keys.
    - [Create a custom field](/docs/api/custom-fields/create): Add a field every contact can hold a value for.
    - [Update a custom field](/docs/api/custom-fields/update): Rename a field or change a dropdown's options.
    - [Delete a custom field](/docs/api/custom-fields/delete): Delete a field and clear its value from every contact.
  - Lists
    - [Lists](/docs/api/lists): Named, hand-picked groups of contacts.
    - [List lists](/docs/api/lists/list): All your contact lists, most recently changed first.
    - [Create a list](/docs/api/lists/create): Create an empty list, then add people to it.
    - [Get a list](/docs/api/lists/get): One list by id.
    - [Update a list](/docs/api/lists/update): Rename a list or change its description.
    - [Delete a list](/docs/api/lists/delete): Delete a list. The people in it are kept.
    - [Add people to a list](/docs/api/lists/add-contacts): Add existing contacts by id, or anyone by email address.
    - [Remove people from a list](/docs/api/lists/remove-contacts): Take people out of a list. The contacts are kept.
  - Emails
    - [Send an email](/docs/api/emails/send): Send one email to one person from your connected Gmail.
    - [Scheduled emails](/docs/api/emails/scheduled): List, change or cancel emails sent with sendAt.
  - Do-not-email list
    - [Do-not-email list](/docs/api/do-not-email): Addresses that unsubscribed or were blocked. Nothing is ever sent to them.
    - [List the do-not-email list](/docs/api/do-not-email/list): Who unsubscribed or was blocked, newest first.
    - [Add addresses to the do-not-email list](/docs/api/do-not-email/add): Stop emailing people who asked you to, or import a suppression list.
    - [Remove an address from the do-not-email list](/docs/api/do-not-email/remove): Let someone be emailed again, only because they asked.
  - Events
    - [Record an event](/docs/api/events/track): Tell Pedibee something a person did in your product, so automations can start, wait or stop.
    - [Record several events](/docs/api/events/batch): Up to 100 events in one request, each one handled on its own.
- MCP & AI agents: Connect an assistant to your workspace
  - [MCP & AI agents](/docs/mcp): Connect Claude, ChatGPT, Cursor or your own agent to a Pedibee workspace, and everything an agent needs to work in it well.
  - [Connect an assistant](/docs/mcp/connect): Add the Pedibee MCP server to Claude, ChatGPT, Claude Code, Cursor, VS Code or your own client, and approve it in Pedibee.
  - [Rules and limits](/docs/mcp/rules): What the server enforces on every call, what the agent should do on its own, and how errors come back.
  - [Playbooks](/docs/mcp/playbooks): Common requests as tool sequences, with the checks a careful agent makes along the way.
  - [Tool reference](/docs/mcp/tools): Every tool the Pedibee MCP server offers, with the access it needs and its inputs. Generated from the server's own definitions.