# Title ## Docs - Root [Litemail Docs](https://docs.litemail.ai/litemail-docs-1645474m0.md): ## API Docs - Root > Users [Retrieve User Details](https://docs.litemail.ai/retrieve-user-details-22219775e0.md): This endpoint allows you to fetch information about the currently authenticated user, including their domains, mailboxes, subscriptions, and transaction history. - Root > Workspaces [Retrieve All Workspaces](https://docs.litemail.ai/retrieve-all-workspaces-22268613e0.md): Fetch all workspaces owned by the authenticated user. - Root > Workspaces [Create New Workspace](https://docs.litemail.ai/create-new-workspace-22268614e0.md): Create a new workspace for the authenticated user. - Root > Workspaces [Update Workspace](https://docs.litemail.ai/update-workspace-22268615e0.md): Update details of an existing workspace. - Root > Billings [Add Billing Details](https://docs.litemail.ai/add-billing-details-22268631e0.md): Add billing details for the authenticated user. - Root > Mailboxes [Retrieve Mailboxes](https://docs.litemail.ai/retrieve-mailboxes-22252558e0.md): Fetch all mailboxes owned by the authenticated user. - Root > Mailboxes [Assign New Mailbox to Domain](https://docs.litemail.ai/assign-new-mailbox-to-domain-22268148e0.md): Create and assign a new mailbox under a domain owned by the user. - Root > Mailboxes [Get Mailbox Details](https://docs.litemail.ai/get-mailbox-details-22268149e0.md): Retrieve details of a specific mailbox by its ID. - Root > Mailboxes [Update Mailbox](https://docs.litemail.ai/update-mailbox-22268150e0.md): Update mailbox details such as full name or status. - Root > Mailboxes [Remove Mailbox (Next Renewal)](https://docs.litemail.ai/remove-mailbox-next-renewal-22268151e0.md): Mark a mailbox for removal at the next renewal cycle. - Root > Payment & Wallet [Get Wallet Balance](https://docs.litemail.ai/get-wallet-balance-22268667e0.md): Retrieve the current wallet balance for the authenticated user. - Root > Payment & Wallet [Add Balance to Wallet](https://docs.litemail.ai/add-balance-to-wallet-22268668e0.md): Add funds to the wallet of the authenticated user. - Root > Payment & Wallet [Enable Auto Recharge](https://docs.litemail.ai/enable-auto-recharge-22268669e0.md): Enable auto recharge for the user’s wallet when balance goes below a threshold. - Root > Exports [Export Mailboxes](https://docs.litemail.ai/export-mailboxes-22268707e0.md): Export all mailboxes associated with the authenticated user. - Root > Exports [Add Third Party Account Details](https://docs.litemail.ai/add-third-party-account-details-22268708e0.md): Add details of a third-party account for export integration. - Root > Exports [Update Third Party Account Details](https://docs.litemail.ai/update-third-party-account-details-22268709e0.md): Update details of an existing third-party account. - Root > Subscriptions [Get All Subscriptions](https://docs.litemail.ai/get-all-subscriptions-22268710e0.md): Retrieve all subscriptions owned by the authenticated user. - Root > Subscriptions [Cancel Subscription](https://docs.litemail.ai/cancel-subscription-22268711e0.md): Cancel an existing subscription by its ID. - Root > Subscriptions [Upgrade Subscription](https://docs.litemail.ai/upgrade-subscription-22268712e0.md): Upgrade an existing subscription to a higher plan. - Root > Domains [Retrieve Domains](https://docs.litemail.ai/retrieve-domains-22250355e0.md): Fetch all domains owned by the authenticated user. - Root > Domains [List Assignable Domains](https://docs.litemail.ai/list-assignable-domains-22268202e0.md): Get all domains that can be assigned to users or mailboxes. - Root > Domains [Add DMARC Records](https://docs.litemail.ai/add-dmarc-records-22268203e0.md): Configure DMARC records for a specific domain. - Root > Domains [Add Domain Forwarding](https://docs.litemail.ai/add-domain-forwarding-22268204e0.md): Set up domain email forwarding. - Root > Domains [Remove Domain Forwarding](https://docs.litemail.ai/remove-domain-forwarding-22268205e0.md): Delete existing domain forwarding configuration. - Root > Domains [Get Name Servers](https://docs.litemail.ai/get-name-servers-22268206e0.md): Retrieve name servers for connecting the domain. - Root > Domains [Verify Name Server Propagation](https://docs.litemail.ai/verify-name-server-propagation-22268207e0.md): Check if domain name servers have propagated. - Root > Domains [Connect Domains with LiteMail AI](https://docs.litemail.ai/connect-domains-with-litemail-ai-22268208e0.md): Link a domain with Zapmail service. - Root > Domains [Enable Email Forwarding](https://docs.litemail.ai/enable-email-forwarding-22268209e0.md): Turn on email forwarding for the domain. - Root > Domains [Remove Email Forwarding](https://docs.litemail.ai/remove-email-forwarding-22268210e0.md): Disable email forwarding for the domain. - Root > Domains [Enable Catch-All Emails](https://docs.litemail.ai/enable-catch-all-emails-22268211e0.md): Enable catch-all for the given domain. - Root > Domains [Remove Catch-All Emails](https://docs.litemail.ai/remove-catch-all-emails-22268212e0.md): Disable catch-all for the given domain. - Root > Domains [Check DNS Records](https://docs.litemail.ai/check-dns-records-22268213e0.md): Verify if DNS records are configured correctly for the domain. - Root > Domains [Remove Unused Domain](https://docs.litemail.ai/remove-unused-domain-22268214e0.md): Delete a domain that is no longer used. - Root > Domains [Get Available Domains for Registration](https://docs.litemail.ai/get-available-domains-for-registration-22268215e0.md): List domains that can be registered by the user. - Root > Domains [Get Domain Purchase Payment Link](https://docs.litemail.ai/get-domain-purchase-payment-link-22268216e0.md): Retrieve payment link for registering a domain. - Root > DNS [Get DNS Records](https://docs.litemail.ai/get-dns-records-22269590e0.md): Retrieve all DNS records for the authenticated user's domain or workspace. - Root > DNS [Add DNS Record](https://docs.litemail.ai/add-dns-record-22269591e0.md): Create a new DNS record for a domain. - Root > DNS [Update DNS Record](https://docs.litemail.ai/update-dns-record-22269592e0.md): Update details of an existing DNS record. - Root > DNS [Delete DNS Record](https://docs.litemail.ai/delete-dns-record-22269593e0.md): Remove a DNS record by ID. - Root > apikeys testing [generate key by login first](https://docs.litemail.ai/generate-key-by-login-first-22361132e0.md): - Root > Connect Inbox [connect-inboxes](https://docs.litemail.ai/connect-inboxes-27356177e0.md): - Root > Users [Retrieve User Details](https://docs.litemail.ai/retrieve-user-details-36496137e0.md): This endpoint allows you to fetch information about the currently authenticated user, including their domains, mailboxes, subscriptions, and transaction history. - Root > Domains [Retrieve Domains](https://docs.litemail.ai/retrieve-domains-36496138e0.md): Fetch all domains owned by the authenticated user. Supports pagination and optional name filtering. - Root > Domains [Purchase/Register a New Domain](https://docs.litemail.ai/purchaseregister-a-new-domain-36496139e0.md): **Coming soon** — not yet available in this version. Purchase or register a new domain for use with LiteMail. - Root > Domains [List Assignable Domains](https://docs.litemail.ai/list-assignable-domains-36496140e0.md): Get all domains that can be assigned to users or mailboxes. - Root > Domains [Add DMARC Records](https://docs.litemail.ai/add-dmarc-records-36496141e0.md): Configure DMARC records for a specific domain. - Root > Domains [Add Domain Forwarding](https://docs.litemail.ai/add-domain-forwarding-36496142e0.md): Set up domain email forwarding. - Root > Domains [Remove Domain Forwarding](https://docs.litemail.ai/remove-domain-forwarding-36496143e0.md): Delete existing domain forwarding configuration. - Root > Domains [Get Name Servers](https://docs.litemail.ai/get-name-servers-36496144e0.md): Retrieve name servers for connecting the domain. - Root > Domains [Verify Name Server Propagation](https://docs.litemail.ai/verify-name-server-propagation-36496145e0.md): Check if domain name servers have propagated. - Root > Domains [Connect Domains with LiteMail](https://docs.litemail.ai/connect-domains-with-litemail-36496146e0.md): Link a domain with LiteMail service. - Root > Domains [Enable Email Forwarding](https://docs.litemail.ai/enable-email-forwarding-36496147e0.md): Turn on email forwarding for the domain. - Root > Domains [Remove Email Forwarding](https://docs.litemail.ai/remove-email-forwarding-36496148e0.md): Disable email forwarding for the domain. - Root > Domains [Enable Catch-All Emails](https://docs.litemail.ai/enable-catch-all-emails-36496149e0.md): Enable catch-all for the given domain. - Root > Domains [Remove Catch-All Emails](https://docs.litemail.ai/remove-catch-all-emails-36496150e0.md): Disable catch-all for the given domain. - Root > Domains [Check DNS Records](https://docs.litemail.ai/check-dns-records-36496151e0.md): Verify if DNS records are configured correctly for the domain. - Root > Domains [Get Domain Details](https://docs.litemail.ai/get-domain-details-36496152e0.md): Retrieve details of a single domain owned by the authenticated user. - Root > Domains [Remove Unused Domain](https://docs.litemail.ai/remove-unused-domain-36496153e0.md): Delete a domain that is no longer used. - Root > Domains [Get Available Domains for Registration](https://docs.litemail.ai/get-available-domains-for-registration-36496154e0.md): List domains that can be registered by the user. - Root > Domains [Get Domain Purchase Payment Link](https://docs.litemail.ai/get-domain-purchase-payment-link-36496155e0.md): Retrieve payment link for registering a domain. - Root > Mailboxes [Retrieve Mailboxes](https://docs.litemail.ai/retrieve-mailboxes-36496156e0.md): Fetch all mailboxes owned by the authenticated user. Pass `?email=john@b2bforcelabs.com` to look up a single mailbox directly by its email address. Supports pagination and optional username filtering. - Root > Mailboxes [Assign New Mailbox to Domain](https://docs.litemail.ai/assign-new-mailbox-to-domain-36496157e0.md): Create and assign a new mailbox under a domain owned by the user. - Root > Mailboxes [Get Mailbox Details](https://docs.litemail.ai/get-mailbox-details-36496158e0.md): Retrieve details of a specific mailbox by its ID. - Root > Mailboxes [Update Mailbox](https://docs.litemail.ai/update-mailbox-36496159e0.md): Update mailbox details such as full name or status. - Root > Mailboxes [Remove Mailbox (Next Renewal)](https://docs.litemail.ai/remove-mailbox-next-renewal-36496160e0.md): Mark a mailbox for removal at the next renewal cycle. - Root > Mailboxes [Get Warmup Analytics for Mailboxes](https://docs.litemail.ai/get-warmup-analytics-for-mailboxes-36496161e0.md): **Coming soon** — not yet available in this version. Get warmup analytics and progress for mailboxes. - Root > Workspaces [Retrieve All Workspaces](https://docs.litemail.ai/retrieve-all-workspaces-36496162e0.md): Fetch all workspaces owned by the authenticated user. - Root > Workspaces [Create New Workspace](https://docs.litemail.ai/create-new-workspace-36496163e0.md): Create a new workspace for the authenticated user. - Root > Workspaces [Update Workspace](https://docs.litemail.ai/update-workspace-36496164e0.md): Update details of an existing workspace. - Root > Billings [Add Billing Details](https://docs.litemail.ai/add-billing-details-36496165e0.md): Add billing details for the authenticated user. - Root > Payment & Wallet [Get Wallet Balance](https://docs.litemail.ai/get-wallet-balance-36496166e0.md): Retrieve the current wallet balance for the authenticated user. - Root > Payment & Wallet [Add Balance to Wallet](https://docs.litemail.ai/add-balance-to-wallet-36496167e0.md): Add funds to the wallet of the authenticated user. - Root > Payment & Wallet [Enable Auto Recharge](https://docs.litemail.ai/enable-auto-recharge-36496168e0.md): Enable auto recharge for the user's wallet when balance goes below a threshold. - Root > Wallet [Add Credit to Wallet](https://docs.litemail.ai/add-credit-to-wallet-36496169e0.md): **Coming soon** — not yet available in this version. Add credit to your wallet using a payment method. - Root > Wallet [List Billing Invoices](https://docs.litemail.ai/list-billing-invoices-36496170e0.md): **Coming soon** — not yet available in this version. List all billing invoices for the authenticated user. - Root > Exports [Export Mailboxes](https://docs.litemail.ai/export-mailboxes-36496171e0.md): Export all mailboxes associated with the authenticated user. - Root > Exports [Add Third Party Account Details](https://docs.litemail.ai/add-third-party-account-details-36496172e0.md): Add details of a third-party account for export integration. - Root > Exports [Update Third Party Account Details](https://docs.litemail.ai/update-third-party-account-details-36496173e0.md): Update details of an existing third-party account. - Root > Exports [Connect Inboxes (Export to Platform)](https://docs.litemail.ai/connect-inboxes-export-to-platform-36496174e0.md): Submit platform credentials and a list of inboxes to connect/export. Creates a `connect_inbox` record (upserted by platform+workspace+client) and an `ExportHistory` record with status `IN_PROGRESS`. Also fires Google Sheets logging in the background. - Root > Subscriptions [Get All Subscriptions](https://docs.litemail.ai/get-all-subscriptions-36496175e0.md): Retrieve all subscriptions owned by the authenticated user. - Root > Subscriptions [Cancel Subscription](https://docs.litemail.ai/cancel-subscription-36496176e0.md): Cancel an existing subscription by its ID. - Root > Subscriptions [Upgrade Subscription](https://docs.litemail.ai/upgrade-subscription-36496177e0.md): Upgrade an existing subscription to a higher plan. - Root > DNS [Get DNS Records](https://docs.litemail.ai/get-dns-records-36496178e0.md): Retrieve all DNS records for a domain. Requires `domain` (domain name) as a query parameter. - Root > DNS [Create DNS Record](https://docs.litemail.ai/create-dns-record-36496179e0.md): Create a new DNS record for a domain. If the domain uses Cloudflare, the record is also synced to Cloudflare. You may use either `name` or `host` (aliases), and either `type` or `recordType` (aliases). At least one of each pair is required. - Root > DNS [Update DNS Record](https://docs.litemail.ai/update-dns-record-36496180e0.md): Update an existing DNS record by its ID or Cloudflare record ID. Syncs the change to Cloudflare if applicable. - Root > DNS [Delete DNS Record](https://docs.litemail.ai/delete-dns-record-36496181e0.md): Delete a DNS record by its ID or Cloudflare record ID. Also removes it from Cloudflare if applicable. - Root > Tags [List Tags](https://docs.litemail.ai/list-tags-36496182e0.md): Retrieve all tags associated with domains owned by the authenticated user. - Root > Tags [Create Tag](https://docs.litemail.ai/create-tag-36496183e0.md): Create a new tag on a domain owned by the authenticated user. Either `name`/`tagName` and either `domain`/`domainId` are accepted for backward compatibility - Root > Tags [Update Tag](https://docs.litemail.ai/update-tag-36496184e0.md): Update an existing tag by its ID. Verifies domain ownership before updating. Use `domain` (domain name) and `name` for tag name. The legacy fields `domainId` and `tagName` are still accepted for backwards compatibility. - Root > Tags [Delete Tag](https://docs.litemail.ai/delete-tag-36496185e0.md): Delete a tag by its ID. Verifies domain ownership before deleting. - Root > MailBoxes [Assign Mailboxes to Domain](https://docs.litemail.ai/assign-mailboxes-to-domain-36496186e0.md): Assign one or more mailboxes to domains. Each mailbox must specify a `domain` and either `mailboxUsername` or legacy `userName`. Returns created mailbox records. Either `mailboxUsername` or legacy `userName` is accepted - Root > Placement [List Placement Tests](https://docs.litemail.ai/list-placement-tests-36496187e0.md): Retrieve all placement (deliverability) tests created by the authenticated user. - Root > Placement [Create Placement Test](https://docs.litemail.ai/create-placement-test-36496188e0.md): Create a new placement (deliverability) test. Provide either `mailboxIds` or `emails` (or both) to determine which mailboxes to test. - Root > Dashboard [Get Dashboard Overview](https://docs.litemail.ai/get-dashboard-overview-36496189e0.md): Returns aggregate counts and plan details for the authenticated user: total domains, mailboxes (available/used/total), and current plan info. - Root > Dashboard [Get Mailbox Status Counts](https://docs.litemail.ai/get-mailbox-status-counts-36496190e0.md): Returns mailbox counts broken down by lifecycle status (active, pending, suspended, deleted) across all domains accessible to the authenticated user. - Root > Export History [List Export History](https://docs.litemail.ai/list-export-history-36496191e0.md): Retrieve a paginated list of export history records for the authenticated user. Filterable by `platform` and `exportStatus`. - Root > Export History [Create Export History Record](https://docs.litemail.ai/create-export-history-record-36496192e0.md): Manually create an export history record for tracking a mailbox export job. - Root > Cloudflare [Get Cloudflare Credentials & Zones](https://docs.litemail.ai/get-cloudflare-credentials-zones-36496193e0.md): Returns the saved Cloudflare credentials for the authenticated user and lists all active zones in their Cloudflare account, marking which domains are already connected to LiteMail. - Root > Cloudflare [Save Credentials or Connect Domain](https://docs.litemail.ai/save-credentials-or-connect-domain-36496194e0.md): Two modes based on request body: - Root > Webhooks [List Registered Webhooks](https://docs.litemail.ai/list-registered-webhooks-36496195e0.md): **Coming soon** — not yet available in this version. List all registered webhook endpoints for the authenticated user. - Root > Webhooks [Register a New Webhook Endpoint](https://docs.litemail.ai/register-a-new-webhook-endpoint-36496196e0.md): **Coming soon** — not yet available in this version. Register a new webhook endpoint to receive event notifications. - Root > Webhooks [Delete a Webhook](https://docs.litemail.ai/delete-a-webhook-36496197e0.md): **Coming soon** — not yet available in this version. Delete a registered webhook endpoint by its ID.