# Endpoint reference

> The AY Inbox REST API reference, one page per resource: mailboxes, campaigns, contacts, the unified inbox, CRM, analytics, webhooks, booking and API keys.

Source: https://docs.ayinbox.com/api/reference/

The endpoint reference documents the AY Inbox REST API one resource at a time, with each route's parameters, required scope and example responses. Paths are relative to `https://api.ayinbox.com/v1`. The [endpoint scope map](/api/endpoints/) lists every route on one page with whether it accepts an API key, and [error codes](/api/error-codes/) covers the error shape they share.

* [Mailboxes](/api/reference/mailboxes/): list and update sender mailboxes, set a tracking domain, run warmup, check domain authentication and send from a mailbox.
* [Campaigns](/api/reference/campaigns/): create campaigns and their steps, manage senders, A/B variants and attachments, run preflight, and start or stop sending.
* [Contacts](/api/reference/contacts/): search, create, bulk edit, import, export and verify contacts, and read each contact's emails, notes, activities and deals.
* [Unified inbox](/api/reference/unibox/): read mail and threads across every mailbox, reply, set labels, snooze threads and manage scheduled sends.
* [CRM](/api/reference/crm/): pipelines, stages, deals and tasks, and the settings that run the CRM on HubSpot or Pipedrive.
* [Analytics and audit](/api/reference/analytics/): the dashboard rollups, deliverability, warmup placement, campaign stats, mailbox health, usage and the audit log.
* [Inbox placement tests](/api/reference/placement/): start tests and batches, read where each copy landed, and manage seed inboxes and a campaign's placement monitor.
* [API keys](/api/reference/api-keys/): create, rotate and revoke keys, restrict them to IPs or mailboxes, and read each key's usage.
* [Webhooks](/api/reference/webhooks/): register endpoints, filter event types, rotate the signing secret, redeliver failures, and check the signed payload.
* [Integrations, automations and meetings](/api/reference/integrations/): the app catalog, connections, automation flows, booked meetings and Google Sheets lead syncs.
* [Calendar booking](/api/reference/booking/): read open Cal.com or Calendly times, offer them in a reply, and book the time the prospect picks.
* [Deliverability and ops](/api/reference/deliverability-ops/): report bounces and complaints, manage the suppression list, replay dead-lettered tasks, and set warmup routing and reply templates.
* [Account and organization](/api/reference/account-org/): sign-in, sessions, profile, two-factor and passkeys, members, invitations, roles, teams and billing. Most of these routes are session only.
