# Allo help center and API reference > Documentation and support for Allo, the business phone system that does the work your calls create ## Get started - [Help Center](https://www.withallo.com/help.md): Find answers, explore features, and build with our API. - [What is Allo?](https://www.withallo.com/help/get-started/what-is-allo.md): Learn about Allo, the AI-first phone system built for small sales teams - [Numbers and users](https://www.withallo.com/help/get-started/numbers-and-users.md): Two distinct building blocks, and why understanding the difference matters - [Solo User](https://www.withallo.com/help/get-started/solo-user.md): Set up Allo for yourself in minutes - [Team Admin](https://www.withallo.com/help/get-started/team-admin.md): Set up Allo for your entire team - [Team Member](https://www.withallo.com/help/get-started/team-member.md): Join your team on Allo - [Identity Verification](https://www.withallo.com/help/get-started/identity-verification.md): Understand the identity verification process to activate your Allo account ## Calling - [Set Allo as your default calling app](https://www.withallo.com/help/get-started/default-calling-app.md): Turn on System Calling in the Allo mobile app so calls you start by tapping a number in a CRM, a browser, or any other app go through Allo, on Android and iPhone - [Call Phone Numbers From Websites](https://www.withallo.com/help/features/browser-phone-links.md): Turn on Use Allo for phone links in the Allo web app, and clicking a phone number on a website or in a web CRM starts the call in Allo - [Click-to-call number](https://www.withallo.com/help/phone-numbers/click-to-call-number.md): Choose which number appears when you make outbound calls with multiple numbers assigned - [Power Dialer](https://www.withallo.com/help/features/power-dialer.md): Load a list of numbers and let Allo dial them back to back, so reps spend their time talking instead of clicking - [Personal Inboxes](https://www.withallo.com/help/features/personal-inboxes.md): Follow the calls and texts that concern you in one list: several lines combined, or one line narrowed to a phone menu option or a call tag - [Call Transfer](https://www.withallo.com/help/features/call-transfer.md): Transfer a live call to a teammate, either right away or after you talk to them first while the caller waits on hold - [Conference Calls](https://www.withallo.com/help/features/conference-calls.md): Add a teammate or an outside phone number to a live call, so three or more people talk on the same call ## Incoming calls - [AI Receptionist](https://www.withallo.com/help/features/ai-receptionist.md): An AI agent on your line that answers calls, takes messages, transfers callers, and books meetings - [AI Receptionist and Your Apps](https://www.withallo.com/help/features/ai-receptionist-connectors.md): Choose which connected apps and tools your AI receptionist can use during calls and messages, agent by agent. - [Voicemail](https://www.withallo.com/help/features/voicemail.md): Add a Voicemail step to your line's call flow and set the greeting callers hear - [Call Flows](https://www.withallo.com/help/features/call-flows.md): Build what happens when someone calls your line, step by step, on a visual canvas - [Build a Phone Menu](https://www.withallo.com/help/features/call-flows-phone-menu.md): Greet callers, give them keypad options, and send each one to the right place - [Ring Your Team](https://www.withallo.com/help/features/call-flows-ring.md): Ring this line is the call flow step that makes phones ring. Name the members, pick the order, set the ring time, and choose what happens if nobody answers - [Recordings and Audio](https://www.withallo.com/help/features/call-flows-audio.md): Record, upload or write every message a caller hears in your call flow - [Route by Schedule and by Caller](https://www.withallo.com/help/features/call-flows-routing.md): Send calls down different paths depending on the time of day or on who is calling - [Call Flow Troubleshooting](https://www.withallo.com/help/features/call-flows-troubleshooting.md): Fixes for the problems people hit most often when building a call flow - [Business Hours](https://www.withallo.com/help/features/business-hours.md): Send calls one way when you are open and another way when you are closed, with a Business hours step in your line's call flow - [Phone Menu](https://www.withallo.com/help/features/ivr.md): Greet callers and let them press a key to reach the right person, with a Phone menu step in your line's call flow - [Call Routing](https://www.withallo.com/help/features/call-routing.md): Choose who rings when a call comes in, in what order and for how long, with a Ring this line step in your line's call flow ## After a call - [Call Recordings](https://www.withallo.com/help/features/call-recordings.md): Automatic call recording, transcription, and AI summaries - [Allo AI](https://www.withallo.com/help/features/ai-assistant.md): Ask Allo AI about your calls, texts, contacts and lines in plain words, or ask it to draft a message or do the work - [Call Tags](https://www.withallo.com/help/features/call-tags.md): Categorize calls during or after they happen, manually or automatically with AI, and sync them to HubSpot - [Threads](https://www.withallo.com/help/features/threads.md): Discuss a call or a message with your team, right where it happened. Threads are internal and the contact never sees them ## Phone numbers - [Your Allo number](https://www.withallo.com/help/phone-numbers/understanding-allo-number.md): Learn about your Allo business number and how it works - [Buy additional numbers](https://www.withallo.com/help/phone-numbers/buy-additional-numbers.md): Add more phone numbers to your Allo account - [International phone numbers](https://www.withallo.com/help/phone-numbers/international-numbers.md): Complete list of 120+ countries where you can get a business phone number with Allo — including setup times, document requirements, and SMS availability - [Port existing number](https://www.withallo.com/help/phone-numbers/port-existing-number.md): Transfer your current phone number to Allo, for free, in a few business days - [Port your number out of Allo](https://www.withallo.com/help/phone-numbers/port-out.md): Leave with your number: RIO codes, port-out info, and steps - [Connect personal number](https://www.withallo.com/help/phone-numbers/connect-personal-number.md): Forward calls from your existing phone number to Allo to get AI features on all your calls - [eSIM (France)](https://www.withallo.com/help/phone-numbers/esim.md): Put your Allo number in your phone's dialer and take calls over the French mobile network, without depending on Wi-Fi - [Caller ID Name (CNAM)](https://www.withallo.com/help/phone-numbers/caller-id-name.md): Display your business name when you call US and Canadian numbers - [Number Reputation](https://www.withallo.com/help/phone-numbers/number-reputation.md): Why a number picks up a Spam Likely label, how carriers score a number's reputation, and the steps that clear a flagged number. - [Connect to WhatsApp](https://www.withallo.com/help/phone-numbers/connect-to-whatsapp.md): Use your Allo number for WhatsApp ## SMS - [SMS & messaging](https://www.withallo.com/help/phone-numbers/sms-overview.md): Send and receive text messages from your business number: what works in each country, automatic replies after a missed call, and sending limits. - [Set up texting](https://www.withallo.com/help/phone-numbers/sms-setup.md): The one-time registration your number needs before its first text: 10DLC in the US and Canada, a Sender ID in France, nothing in the UK and Belgium. - [SMS Registration Checklist](https://www.withallo.com/help/phone-numbers/sms-registration-checklist.md): What US carriers check before they approve your 10DLC registration: business details that match your official records, the right opt-in method, and a compliant form if you collect numbers on your website. - [SMS Snippets (Templates)](https://www.withallo.com/help/phone-numbers/sms-snippets.md): Save a text you send often as a snippet, also called an SMS template, saved reply or canned message, and insert it into any conversation in a couple of taps. - [SMS in France](https://www.withallo.com/help/phone-numbers/sms-france.md): The French rules for business texting: why mobile numbers are blocked, Sender ID versus short code, and the ARCEP, CNIL and AF2M obligations. - [SMS rates](https://www.withallo.com/help/billing/sms-rates.md): What a text message costs on Allo: how segments are counted, the per-segment rate for each country, and what is never billed. - [SMS troubleshooting](https://www.withallo.com/help/phone-numbers/sms-troubleshooting.md): Fix texts that won't send, aren't delivered, or aren't received ## Team and account - [Overview](https://www.withallo.com/help/team/overview.md): Collaborate on calls with your team - [Manage team members](https://www.withallo.com/help/team/manage-members.md): Add, remove, and manage your team - [Supervise your team's calls](https://www.withallo.com/help/team/supervise-team-calls.md): What admins can see, team roles, and viewer seats - [Shared contacts](https://www.withallo.com/help/team/shared-contacts.md): How contacts are shared with your team, and how to import a directory - [Analytics](https://www.withallo.com/help/team/analytics.md): Track team performance and call metrics - [Email Notifications](https://www.withallo.com/help/features/email-notifications.md): Choose which calls send you an email, line by line, so your inbox only carries the calls you need to act on ## Integrations - [Overview](https://www.withallo.com/help/integrations/overview.md): Connect Allo with your favorite tools and automate your workflow - [Chrome Extension](https://www.withallo.com/help/integrations/chrome-extension.md): Click-to-call from any website and bulk-import contacts to the Power Dialer - [Embedded Dialer](https://www.withallo.com/help/embedded-dialer.md): Add the Allo dialer inside your own app - [HubSpot](https://www.withallo.com/help/integrations/hubspot.md): Automatically sync call recordings and summaries to your HubSpot CRM - [Salesforce](https://www.withallo.com/help/integrations/salesforce.md): Automatically sync call recordings and summaries to your Salesforce CRM - [Attio](https://www.withallo.com/help/integrations/attio.md): Automatically sync call recordings and summaries to your Attio CRM - [folk](https://www.withallo.com/help/integrations/folk.md): Automatically sync call recordings and summaries to your folk CRM - [Zoho CRM](https://www.withallo.com/help/integrations/zoho.md): Automatically sync contacts and log calls with summaries to your Zoho CRM - [Streak](https://www.withallo.com/help/integrations/streak.md): Automatically sync call recordings and summaries to your Streak CRM - [Odoo](https://www.withallo.com/help/integrations/odoo.md): Automatically recognize contacts from your Odoo CRM and log all calls and messages - [Apollo](https://www.withallo.com/help/integrations/apollo.md): Auto-sync calls, texts, and voicemails to Apollo. Contacts, companies, and deals stay aligned with no manual updates. Business plan only. - [Pipedrive](https://www.withallo.com/help/integrations/pipedrive.md): Automatically log every call as a Pipedrive activity with AI summaries and recordings. Business plan only. - [Sellsy](https://www.withallo.com/help/integrations/sellsy.md): Automatically sync contacts and log calls with summaries to your Sellsy CRM - [Brevo](https://www.withallo.com/help/integrations/brevo.md): Automatically sync call recordings and summaries to your Brevo CRM - [GoHighLevel](https://www.withallo.com/help/integrations/gohighlevel.md): Sync contacts and companies from GoHighLevel into Allo. Every call logs back to GoHighLevel automatically with AI summaries and recordings. - [monday.com](https://www.withallo.com/help/integrations/monday.md): Automatically sync call recordings and summaries to your monday.com board - [noCRM.io](https://www.withallo.com/help/integrations/nocrm.md): Automatically sync call recordings and summaries to your noCRM.io leads - [Pipeline CRM](https://www.withallo.com/help/integrations/pipeline.md): Automatically sync call recordings, summaries and SMS to your Pipeline CRM account - [Follow Up Boss](https://www.withallo.com/help/integrations/followupboss.md): Automatically sync call recordings and summaries to your Follow Up Boss people - [JobNimbus](https://www.withallo.com/help/integrations/jobnimbus.md): Automatically sync call recordings and summaries to your JobNimbus contacts - [eWay-CRM](https://www.withallo.com/help/integrations/eway.md): Sync your eWay-CRM contacts to Allo and log every call and SMS as a journal on the contact and its company - [Jobber](https://www.withallo.com/help/integrations/jobber.md): Sync contacts both ways between Allo and Jobber, and send call recordings and summaries to Jobber - [BoondManager](https://www.withallo.com/help/integrations/boondmanager.md): Sync your BoondManager contacts, candidates and resources to Allo and log every call and SMS as an action in BoondManager - [Close](https://www.withallo.com/help/integrations/close.md): Sync your Close contacts and leads with Allo and log every call and SMS as a native activity on the lead - [Twenty](https://www.withallo.com/help/integrations/twenty.md): Connect Twenty Cloud or a self-hosted Twenty CRM to Allo, sync your people and companies, and log every call and SMS as a note on the person and the company - [ActiveCampaign](https://www.withallo.com/help/integrations/activecampaign.md): Connect ActiveCampaign to Allo, sync your contacts, and log every call and SMS as a note on the contact and its open deal - [AgencyZoom](https://www.withallo.com/help/integrations/agencyzoom.md): Connect AgencyZoom to Allo, sync your customers and leads, and log every call and SMS as a note on the matching customer or lead - [Clio](https://www.withallo.com/help/integrations/clio.md): Sync your Clio Manage contacts with Allo and log every call and SMS as a phone log on the contact and its matter - [Copper](https://www.withallo.com/help/integrations/copper.md): Connect Copper CRM to Allo, sync your people, leads and companies, and log every call as a Phone Call activity and every day of SMS as one SMS activity - [Insightly](https://www.withallo.com/help/integrations/insightly.md): Connect Insightly to Allo, sync your contacts, leads and organizations, and log every call and SMS as an event on the contact and its organization - [Recruiterflow](https://www.withallo.com/help/integrations/recruiterflow.md): Log every Allo call as a native Recruiterflow call on the matching candidate or client contact, log SMS on the profile, and sync your candidates, client contacts and clients to Allo - [Cal.com](https://www.withallo.com/help/integrations/cal-com.md): Connect Cal.com so your AI receptionist books callers straight into one of your event types - [Google Calendar](https://www.withallo.com/help/integrations/google-calendar.md): Connect Google Calendar so your AI receptionist books callers directly onto your calendar - [Calendly](https://www.withallo.com/help/integrations/calendly.md): Connect Calendly so your AI receptionist books callers straight into one of your event types - [Shopify](https://www.withallo.com/help/integrations/shopify.md): Recognize your Shopify customers when they call or text, and log your Allo calls and SMS on the Shopify customer - [Intercom](https://www.withallo.com/help/integrations/intercom.md): Automatically sync call recordings and summaries to your Intercom workspace - [Pylon](https://www.withallo.com/help/integrations/pylon.md): Log every Allo call and SMS in Pylon as an internal issue on the matching contact, and sync your Pylon contacts and accounts to Allo - [Zendesk](https://www.withallo.com/help/integrations/zendesk.md): Log every Allo call and SMS in Zendesk as an internal note on a ticket for the matching end user, and sync your Zendesk end users and organizations to Allo - [Freshdesk](https://www.withallo.com/help/integrations/freshdesk.md): Log every Allo call and SMS in Freshdesk as a private note on a Phone ticket for the matching contact, and sync your Freshdesk contacts and companies to Allo - [Freshservice](https://www.withallo.com/help/integrations/freshservice.md): Log every Allo call and SMS in Freshservice as a private note on a Phone ticket for the matching requester, and sync your Freshservice requesters and departments to Allo - [Front](https://www.withallo.com/help/integrations/front.md): Import every Allo call and SMS into a Front inbox, in one conversation per contact and Allo line, and sync your Front contacts and accounts to Allo - [Kustomer](https://www.withallo.com/help/integrations/kustomer.md): Log every Allo call and SMS on the Kustomer customer timeline as a voice or SMS message, and sync your Kustomer customers and companies to Allo - [Notion](https://www.withallo.com/help/integrations/notion.md): Automatically log call recordings and summaries to your Notion workspace - [Claap](https://www.withallo.com/help/integrations/claap.md): Automatically send your call recordings and transcriptions to Claap for analysis - [Gong](https://www.withallo.com/help/integrations/gong.md): Send every recorded Allo call to Gong so it can transcribe and analyze it - [Avoma](https://www.withallo.com/help/integrations/avoma.md): Send every recorded Allo call to Avoma, with Allo's transcript, so Avoma writes its AI notes - [Chorus](https://www.withallo.com/help/integrations/chorus.md): Send every recorded Allo call to Chorus by ZoomInfo, so Chorus transcribes, analyzes and coaches on it - [evaluagent](https://www.withallo.com/help/integrations/evaluagent.md): Send every recorded Allo call to evaluagent, under the right agent, so evaluagent transcribes and scores it - [Fireflies.ai](https://www.withallo.com/help/integrations/fireflies.md): Send every recorded Allo call to your Fireflies.ai meetings so Fireflies transcribes and summarizes it - [Jiminny](https://www.withallo.com/help/integrations/jiminny.md): Upload every recorded Allo call to Jiminny, on the rep who handled it - [Google Spreadsheet](https://www.withallo.com/help/integrations/google-spreadsheets.md): Automatically log all calls to a Google Spreadsheet - [Google Contacts](https://www.withallo.com/help/integrations/google-contacts.md): Two-way sync between Allo and your Google Contacts - [Zapier](https://www.withallo.com/help/integrations/zapier.md): Connect Allo with 5000+ apps using Zapier automation - [Make](https://www.withallo.com/help/integrations/make.md): Build custom workflows and automations using Allo call data - [Webhooks](https://www.withallo.com/help/integrations/webhooks.md): Receive real-time notifications when calls, SMS, and contacts events happen in your Allo account - [AI Connectors](https://www.withallo.com/help/integrations/ai-connectors.md): Connect your apps and MCP servers to your AI agents, so your AI receptionist and Allo AI can look things up and act in them. - [MCP Server](https://www.withallo.com/help/integrations/mcp.md): Connect Allo to AI assistants like Claude, ChatGPT, Grok, Cursor, and VS Code using the Model Context Protocol - [Claude Connector](https://www.withallo.com/help/integrations/claude-connector.md): Use Allo from inside Claude.ai: look up contacts, send SMS, and check calls without leaving the chat. - [ChatGPT Connector](https://www.withallo.com/help/integrations/chatgpt-connector.md): Install the Allo plugin in ChatGPT, or connect a custom MCP server, to look up contacts, send SMS, and check calls from the chat. - [Grok Connector](https://www.withallo.com/help/integrations/grok-connector.md): Install Allo for Grok Bot, or connect a custom MCP server on grok.com, to look up contacts, send SMS, and check calls from the chat. ## Billing - [Plans and Pricing](https://www.withallo.com/help/billing/plans-and-pricing.md): Compare Solo, Business and Ultra. Per-user pricing, no setup fees, no contracts. - [How the free trial works](https://www.withallo.com/help/billing/free-trial.md): Trial length, what's included, what's restricted, and how billing starts - [Credits](https://www.withallo.com/help/billing/credits.md): Credits are the one balance that pays for international calls and texts on Allo. What your plan includes, how to add more, what happens at zero, and where to see what you spent. - [International calling](https://www.withallo.com/help/billing/international-calling-rates.md): How international calling works on Allo: enabling it on a number, paying with credits, auto top-up, checking rates, and what gets billed. - [Manage Subscription](https://www.withallo.com/help/billing/manage-subscription.md): Plans, pricing, billing, and subscription management - [Add or cancel an add-on](https://www.withallo.com/help/billing/add-ons.md): Add the Power Dialer or the AI Receptionist to your plan, or cancel one yourself from Settings > Billing - [Billing and Payments](https://www.withallo.com/help/billing/billing-and-payments.md): Invoices, payment methods, and billing information - [Refund policy](https://www.withallo.com/help/billing/refund-policy.md): When Allo refunds a charge, and how to request one ## Security and compliance - [Call Recording Compliance](https://www.withallo.com/help/features/call-recording-compliance.md): Configure Allo's compliance tools for call recording laws in the US, EU, and beyond - [HIPAA and BAA](https://www.withallo.com/help/billing/hipaa-compliance.md): Allo signs a HIPAA Business Associate Agreement with healthcare businesses. $50 per month for the whole workspace, on Business and Ultra. ## Partners - [Partner Program](https://www.withallo.com/help/support/partner-program.md): Earn 20% of the first-year revenue of every customer you refer, or resell Allo inside your own offer at 30% off. Two partner contracts, and how to join each one. - [Partner Portal](https://www.withallo.com/help/support/partner-portal.md): Find your referral link and submit warm introductions, or create and set up your customers' accounts. What you can do in the partner portal depends on your partner contract. ## Support - [FAQ](https://www.withallo.com/help/support/faq.md): Quick answers to frequently asked questions - [Common Issues](https://www.withallo.com/help/support/common-issues.md): Solutions to frequently encountered problems - [Audio issues on desktop and web](https://www.withallo.com/help/support/desktop-audio-issues.md): Fix microphone and sound problems on Mac, Windows, and browser - [Verification code not received](https://www.withallo.com/help/support/verification-code-not-received.md): What to do when the SMS or email sign-in code doesn't arrive - [Unexpected verification or cancellation email](https://www.withallo.com/help/support/account-verification-issues.md): What the automated account review emails mean and how to respond - [Contact Support](https://www.withallo.com/help/support/contact.md): Send our team a request from the Allo app or by email ## API: API - [Overview](https://www.withallo.com/docs.md): Integrate Allo's communication capabilities into your applications - [Authentication](https://www.withallo.com/docs/guides/authentication.md): Authenticate API requests using API keys - [Rate limits](https://www.withallo.com/docs/guides/rate-limits.md): Request limits and response headers - [Pagination](https://www.withallo.com/docs/guides/pagination.md): Page-based pagination with total counts on all list endpoints - [Error handling](https://www.withallo.com/docs/guides/error-handling.md): Standardized error responses with actionable suggestions - [Error codes](https://www.withallo.com/docs/guides/error-codes.md): Complete catalog of all API error codes with recovery instructions - [Common use cases](https://www.withallo.com/docs/guides/common-use-cases.md): Examples of how to use the Allo API to answer business questions and automate workflows ## API: Webhooks - [Overview](https://www.withallo.com/docs/webhooks/overview.md): Receive real-time notifications when events occur in your Allo account - [List webhooks](https://www.withallo.com/docs/webhooks/get-webhooks.md): Returns all webhook endpoints configured for your account. - [Get webhook](https://www.withallo.com/docs/webhooks/get-webhook.md): Returns a single webhook endpoint by ID, including its signing secret . - [Create webhook](https://www.withallo.com/docs/webhooks/create-webhook.md): Creates a webhook endpoint subscribed to one or more event topics. The signing secret is returned only in this response — store it to verify delivery… - [Update webhook](https://www.withallo.com/docs/webhooks/update-webhook.md): Updates a webhook endpoint. Only the fields you provide are changed. Omitted fields are left untouched. - [Delete webhook](https://www.withallo.com/docs/webhooks/delete-webhook.md): Permanently deletes a webhook endpoint and its delivery history. - [List event types](https://www.withallo.com/docs/webhooks/list-event-types.md): Returns the catalog of event topics you can subscribe a webhook to. - [Event catalog](https://www.withallo.com/docs/webhooks/event-catalog.md): Full reference for all webhook event types and their payloads - [Verifying webhook signatures](https://www.withallo.com/docs/webhooks/verifying-signatures.md): Authenticate incoming webhooks using HMAC-SHA256 signatures - [Delivery and retries](https://www.withallo.com/docs/webhooks/delivery-and-retries.md): How Allo delivers webhooks, retries failures, and handles recovery - [Testing webhooks](https://www.withallo.com/docs/webhooks/testing.md): Test your webhook endpoints before going live - [Best practices](https://www.withallo.com/docs/webhooks/best-practices.md): Recommendations for building reliable webhook consumers - [Troubleshoot](https://www.withallo.com/docs/webhooks/troubleshooting.md): Diagnose and fix common webhook delivery issues ## API: Conversations - [Overview](https://www.withallo.com/docs/conversations/overview.md): Unified call and SMS history with keyword search and rich filtering - [List conversations](https://www.withallo.com/docs/conversations/list-conversations.md): Returns a paginated list of conversations grouped by contact phone number, sorted by most recent activity. Listing by inbox id or with pinned can return 400… - [Get conversation item](https://www.withallo.com/docs/conversations/get-item.md): Returns a single call or SMS message by its ID. - [Get recording download link](https://www.withallo.com/docs/conversations/get-item-recording.md): Returns a fresh signed link to download a call's recording, valid for 60 minutes. The link works without an Allo login: do not share it beyond the people who… - [Search conversation items](https://www.withallo.com/docs/conversations/search-conversation-items.md): Search and filter items across all conversations. Supports keyword search across transcripts, summaries, and message content. - [Get many conversation items](https://www.withallo.com/docs/conversations/batch-get.md): Returns multiple conversation items by their IDs in a single request. Use this to fetch full details (summary, tags, recording, etc.) for items returned by… - [Execute conversation action](https://www.withallo.com/docs/conversations/execute-action.md): Execute an action on a conversation. - [Update call summary](https://www.withallo.com/docs/conversations/update-summary.md): Replace the markdown content of a call's AI-generated summary. Only call items have summaries — passing an SMS ID ( msg- ) returns 400 INVALID ITEM ID . If… - [Pin conversation](https://www.withallo.com/docs/conversations/pin-conversation.md): Pins a conversation for the caller. Up to 10 conversations can be pinned. Pinning a conversation that is already pinned returns 204 and changes nothing. A… - [Unpin conversation](https://www.withallo.com/docs/conversations/unpin-conversation.md): Unpins a conversation for the caller. Unpinning a conversation that is not pinned returns 204 and changes nothing. ## API: CRM - [Overview](https://www.withallo.com/docs/crm/overview.md): Manage people, companies, and deals in your Allo CRM ## API: People - [Overview](https://www.withallo.com/docs/crm/people-overview.md): Manage people in your Allo CRM - [Get person](https://www.withallo.com/docs/crm/get-person.md): Returns a single person by ID. - [Create person](https://www.withallo.com/docs/crm/create-person.md): Creates a new person in your CRM. Set custom attribute values with custom attributes . A key that is not an active custom attribute returns 400 CUSTOM… - [Update person](https://www.withallo.com/docs/crm/update-person.md): Updates an existing person. Only provided fields will be updated. Set custom attribute values with custom attributes . A key that is not an active custom… - [Search people](https://www.withallo.com/docs/crm/search-people.md): Search and filter people in your CRM with advanced filtering, sorting, and pagination. ## API: Custom fields - [Overview](https://www.withallo.com/docs/crm/attributes-overview.md): Manage custom contact fields in your Allo CRM - [List custom fields](https://www.withallo.com/docs/crm/list-attributes.md): Returns the custom fields defined on your team's people, paginated. Includes the fields you created with the API and the ones synced from your CRM… - [Create custom field](https://www.withallo.com/docs/crm/create-attribute.md): Creates a custom field on your team's people. The key is derived from the label. DROPDOWN fields need a non-empty options list. Creating the same label with… - [Update custom field](https://www.withallo.com/docs/crm/update-attribute.md): Partially updates a custom field on people: only the fields you send change. key and type cannot be changed. Fields synced from a CRM integration cannot be… - [Delete custom field](https://www.withallo.com/docs/crm/delete-attribute.md): Removes a custom field from the API: it disappears from the list, its values are no longer returned on people, and writing to it with custom attributes… ## API: Views - [Overview](https://www.withallo.com/docs/crm/views-overview.md): Manage saved contact views in your Allo CRM - [List views](https://www.withallo.com/docs/crm/list-views.md): Returns the saved contact views you can see: your private views and your team's shared views. page below 1 or size outside 1..100 returns 400 INVALID PAGE… - [Get view](https://www.withallo.com/docs/crm/get-view.md): Returns one saved view by ID. Returns 404 VIEW NOT FOUND for another user's private view. - [Create view](https://www.withallo.com/docs/crm/create-view.md): Creates a saved view: a named filter and sort over people. Filter conditions are combined with AND. Returns 400 validation error with INVALID REQUEST BODY… - [Update view](https://www.withallo.com/docs/crm/update-view.md): Partially updates a view: only the fields you send change. filters: [] clears the filters. Updating a team view requires being its owner or a team ADMIN or… - [Delete view](https://www.withallo.com/docs/crm/delete-view.md): Deletes a view. Deleting a team view requires being its owner or a team ADMIN or MANAGER. Returns 403 VIEW PERMISSION DENIED otherwise, and 404 VIEW NOT… ## API: Companies - [Overview](https://www.withallo.com/docs/crm/companies-overview.md): Manage companies in your Allo CRM - [Get company](https://www.withallo.com/docs/crm/get-company.md): Returns a single company by ID. - [Create company](https://www.withallo.com/docs/crm/create-company.md): Creates a new company in your CRM. Set custom attribute values with custom attributes . A key that is not an active company attribute returns 400 CUSTOM… - [Update company](https://www.withallo.com/docs/crm/update-company.md): Updates an existing company. Only provided fields will be updated. Set custom attribute values with custom attributes . A key that is not an active company… - [Search companies](https://www.withallo.com/docs/crm/search-companies.md): Search and filter companies in your CRM. - [List company attributes](https://www.withallo.com/docs/crm/list-company-attributes.md): Returns the custom attributes defined on your team's companies, paginated, including the ones synced from your CRM integrations. Archived attributes are not… - [Create company attribute](https://www.withallo.com/docs/crm/create-company-attribute.md): Creates a custom attribute on your team's companies. The key is derived from the label. The call is idempotent: if an attribute with the same key and type… - [Update company attribute](https://www.withallo.com/docs/crm/update-company-attribute.md): Partially updates an attribute: only the fields you send change. key and type cannot be changed. Attributes synced from a CRM integration only accept prompt… - [Delete company attribute](https://www.withallo.com/docs/crm/delete-company-attribute.md): Deletes an attribute and clears its value on every company. This cannot be undone. Attributes synced from a CRM integration cannot be deleted. ## API: Deals - [Overview](https://www.withallo.com/docs/crm/deals-overview.md): Access deals synced from your CRM integrations - [Search deals](https://www.withallo.com/docs/crm/search-deals.md): Search and filter deals in your CRM. - [Get deal](https://www.withallo.com/docs/crm/get-deal.md): Returns a single deal by ID. ## API: Notes - [Overview](https://www.withallo.com/docs/notes/overview.md): Internal team notes on conversations and person profiles, with @mentions - [List conversation notes](https://www.withallo.com/docs/notes/list-conversation-notes.md): Returns the internal team notes on a conversation, paginated. - [Create conversation note](https://www.withallo.com/docs/notes/create-conversation-note.md): Adds an internal team note to a conversation. Notes are never visible to the contact. - [Get conversation note](https://www.withallo.com/docs/notes/get-conversation-note.md): Returns a single conversation note by ID. - [Update conversation note](https://www.withallo.com/docs/notes/update-conversation-note.md): Updates a note's content. Only the note's author can edit it. - [Delete conversation note](https://www.withallo.com/docs/notes/delete-conversation-note.md): Deletes a note. Only the note's author can delete it. - [List person notes](https://www.withallo.com/docs/notes/list-person-notes.md): Returns the notes on a person's CRM profile, paginated. - [Create person note](https://www.withallo.com/docs/notes/create-person-note.md): Adds a note to a person's CRM profile. - [Update person note](https://www.withallo.com/docs/notes/update-person-note.md): Updates a person note's content. Only the note's author can edit it. - [Delete person note](https://www.withallo.com/docs/notes/delete-person-note.md): Deletes a person note. Only the note's author can delete it. ## API: Threads - [Overview](https://www.withallo.com/docs/threads/overview.md): Team discussion threads attached to calls, SMS, and conversation notes - [Get thread](https://www.withallo.com/docs/threads/get-thread.md): Returns a thread with all its comments. - [Find thread](https://www.withallo.com/docs/threads/find-thread.md): Finds the discussion thread attached to a conversation item. Returns zero or one thread — each item has at most one thread. - [Create thread](https://www.withallo.com/docs/threads/create-thread.md): Starts a discussion thread on a conversation item with a first comment. Each item can have only one thread. - [Create thread comment](https://www.withallo.com/docs/threads/create-comment.md): Adds a comment to an existing thread. - [Update thread comment](https://www.withallo.com/docs/threads/update-comment.md): Updates a comment's content. Only the comment's author can edit it. - [Resolve thread](https://www.withallo.com/docs/threads/resolve-thread.md): Marks a thread as resolved. - [Unresolve thread](https://www.withallo.com/docs/threads/unresolve-thread.md): Reopens a resolved thread. ## API: Inboxes - [Overview](https://www.withallo.com/docs/inboxes/overview.md): Create, update and delete personal inboxes, and list the conversations of an inbox - [List inboxes](https://www.withallo.com/docs/inboxes/list-inboxes.md): Returns the caller's inboxes. With user id , returns a teammate's inboxes that have at least one source in a workspace the caller manages, showing only those… - [Get inbox suggestions](https://www.withallo.com/docs/inboxes/get-inbox-suggestions.md): Ready-made inbox sources ranked from the caller's recent calls and texts, including phone-menu branches. Each suggestion carries a source to put in sources… - [List menu options](https://www.withallo.com/docs/inboxes/list-menu-options.md): Flattens the phone-menu tree of the line's published call flow. Each option carries a ready MENU BRANCH condition. A line without a phone menu, or whose… - [Create inbox](https://www.withallo.com/docs/inboxes/create-inbox.md): Creates an inbox for the caller, or for a teammate with user id in the body. Every source line must be accessible to the inbox owner. Up to 50 inboxes per… - [Update inbox](https://www.withallo.com/docs/inboxes/update-inbox.md): Updates the fields sent and leaves the others unchanged. Use notifications muted to mute or unmute the inbox, and favorite to star or unstar it. Sending… - [Delete inbox](https://www.withallo.com/docs/inboxes/delete-inbox.md): Deletes the inbox. Conversations are not affected. With user id , an inbox with no source in a workspace the caller manages returns 404 , and an inbox that… ## API: Phone Numbers - [Overview](https://www.withallo.com/docs/phone-numbers/overview.md): Access your Allo phone numbers, sender IDs, and their capabilities - [List phone numbers](https://www.withallo.com/docs/phone-numbers/list-numbers.md): Returns all phone numbers and sender IDs on your team. - [Get call flow](https://www.withallo.com/docs/phone-numbers/get-call-flow.md): Returns the call flow for a phone number. By default returns the published flow (or an in-memory synthesis of the legacy IVR if none is published); pass… - [Get call flow draft](https://www.withallo.com/docs/phone-numbers/get-call-flow-draft.md): Returns the working draft of a phone number's call flow. Unlike GET /v2/api/numbers/ /call flow?status=draft , this endpoint does NOT fall back to the… - [Save call flow draft](https://www.withallo.com/docs/phone-numbers/save-call-flow-draft.md): Creates or updates the working draft of a phone number's call flow. The draft is validated leniently and is not live until published. Optimistic concurrency… - [Publish call flow](https://www.withallo.com/docs/phone-numbers/publish-call-flow.md): Publishes the working draft, making it the live call flow for the phone number. This changes live inbound routing immediately. Runs full validation, which is… ## API: AI Receptionist - [Overview](https://www.withallo.com/docs/agent/overview.md): Read and write the AI receptionist of an Allo line: prompt, voice, business hours, transfer rules, calendars and knowledge - [Get configuration](https://www.withallo.com/docs/agent/get-agent.md): Returns the whole configuration of a line's AI receptionist in one call: business details, voice and language, prompt, capabilities, business hours, transfer… - [Update configuration](https://www.withallo.com/docs/agent/update-agent.md): Updates any part of the configuration except the prompt and the on/off status. Single values are merged, collections are replaced. This does not put the… - [Set prompt](https://www.withallo.com/docs/agent/set-agent-prompt.md): Replaces the receptionist's prompt: what it is trying to achieve, who it is, how it handles the call. A prompt is only valid whole, so read the current… - [Turn on or off](https://www.withallo.com/docs/agent/set-agent-status.md): Puts the receptionist on the line ( ACTIVE ) or takes it off ( FORWARDING , which sends calls to your business phone instead). This reprograms how a live… - [Add website knowledge](https://www.withallo.com/docs/agent/add-website-knowledge.md): Adds a website to the receptionist's knowledge. Allo crawls the site from this URL in the background and returns the entry right away; the receptionist can… - [Enable or disable a website](https://www.withallo.com/docs/agent/update-website-knowledge.md): Turns a website on or off for this line without losing its crawled content. ACTIVE on a website of the team's library that this line does not use yet adds it… - [Delete website knowledge](https://www.withallo.com/docs/agent/delete-website-knowledge.md): Deletes a website from the team's knowledge library, for every line of the team. To stop only this line using it, disable it instead. - [Delete file knowledge](https://www.withallo.com/docs/agent/delete-file-knowledge.md): Deletes an uploaded document from the team's knowledge library, for every line of the team. Documents are uploaded in the Allo app; this API lists and… - [List calendars](https://www.withallo.com/docs/agent/list-calendars.md): Lists the calendars connected to your workspace that you can see, whether or not a receptionist books on them. An admin sees every calendar in the workspace… - [Get a calendar](https://www.withallo.com/docs/agent/get-calendar.md): Returns one connected calendar with the event types its provider currently offers, read live from the provider. This is the catalog you pick from when… - [List voices](https://www.withallo.com/docs/agent/list-voices.md): Lists the voices an AI receptionist can speak with, the same catalog the Allo app offers. Each id is what voice id takes, and a voice speaks the language it… ## API: Tags - [Overview](https://www.withallo.com/docs/tags/overview.md): Discover available call tags for filtering conversations - [List tags](https://www.withallo.com/docs/tags/list-tags.md): Returns all tags configured on the team. - [Create tag](https://www.withallo.com/docs/tags/create-tag.md): Creates a new tag on the team. The tag key is auto-generated by slugifying the name. - [Delete tag](https://www.withallo.com/docs/tags/delete-tag.md): Soft-deletes a tag by its key. Tags synced from a CRM integration cannot be deleted via the API. - [Add tags](https://www.withallo.com/docs/tags/add-tags.md): Add one or more tags to a conversation item. - [Remove tag](https://www.withallo.com/docs/tags/remove-tag.md): Remove a tag from a conversation item. ## API: Summary Templates - [Overview](https://www.withallo.com/docs/summary-templates/overview.md): Manage the call summary templates that shape AI-generated call summaries - [List summary templates](https://www.withallo.com/docs/summary-templates/list-summary-templates.md): Returns the team's call summary templates. - [Get summary template](https://www.withallo.com/docs/summary-templates/get-summary-template.md): Returns a single call summary template by ID. - [Create summary template](https://www.withallo.com/docs/summary-templates/create-summary-template.md): Creates a call summary template for the team. - [Update summary template](https://www.withallo.com/docs/summary-templates/update-summary-template.md): Replaces a summary template's name, call context, icon, and sections. - [Delete summary template](https://www.withallo.com/docs/summary-templates/delete-summary-template.md): Soft-deletes (deactivates) a summary template. - [Set a number's default template](https://www.withallo.com/docs/summary-templates/set-number-default-summary-template.md): Sets or clears the default summary template used for a phone number's call summaries. Pass summary template id to set it, or null/omit to clear it. ## API: Users - [Overview](https://www.withallo.com/docs/users/overview.md): Access your team roster with roles and status - [Me](https://www.withallo.com/docs/users/me.md): Returns information about the authenticated API key: its scopes, available endpoints, team, and rate limits. No specific scope is required — any valid API… - [List users](https://www.withallo.com/docs/users/list-users.md): Returns all team members. - [Get user](https://www.withallo.com/docs/users/get-user.md): Returns a single team member by their ID. ## API: SMS - [Overview](https://www.withallo.com/docs/sms/overview.md): Send SMS and MMS messages programmatically - [Send SMS](https://www.withallo.com/docs/sms/send-sms.md): Send an SMS message to a US phone number using one of your Allo phone numbers. The recipient must be in the same country as your Allo number. - [Send SMS (France)](https://www.withallo.com/docs/sms/send-sms-france.md): Send an SMS message to a US phone number using one of your Allo phone numbers. The recipient must be in the same country as your Allo number. ## API: Fax - [Overview](https://www.withallo.com/docs/fax/overview.md): Send a PDF as a fax from your Allo line, and read sent and received faxes - [Send fax](https://www.withallo.com/docs/fax/send-fax.md): Sends a PDF as a fax from one of your Allo lines. The line must be a US or Canada local number on which fax is turned on in the number settings ("Send and… ## API: Analytics - [Overview](https://www.withallo.com/docs/analytics/overview.md): Pre-computed call metrics and team performance analytics - [Team metrics](https://www.withallo.com/docs/analytics/team-summary.md): Returns team-wide KPIs with period-over-period comparison and a per-user breakdown. Covers all calls (inbound + outbound). - [Outbound metrics](https://www.withallo.com/docs/analytics/outbound.md): Returns outbound call metrics: dial funnel (dials → connected → conversations → conversions), time series, heatmap, leaderboard, and time spent metrics. ## API: Power Dialer - [Overview](https://www.withallo.com/docs/dialing-queues/overview.md): Manage Power Dialer queues programmatically - [List current queue numbers](https://www.withallo.com/docs/dialing-queues/get-current.md): Returns the numbers in the Power Dialer queue currently assigned to the authenticated user, paginated and ordered by position ascending. data is the list of… - [Upsert current queue](https://www.withallo.com/docs/dialing-queues/update-current.md): Creates or updates the config of the queue assigned to the authenticated user. Send user id or email to act on a teammate's queue instead — user id wins when… - [Append numbers](https://www.withallo.com/docs/dialing-queues/append-numbers.md): Appends phone numbers to the Power Dialer queue assigned to the authenticated user. Creates the queue implicitly if none exists. Send user id or email to… - [Clear queue numbers](https://www.withallo.com/docs/dialing-queues/clear-numbers.md): Removes numbers from the queue assigned to the authenticated user. Exactly one filter must be supplied via query string: number (E.164), position (0-based… - [Reset current queue](https://www.withallo.com/docs/dialing-queues/reset-current.md): Creates a fresh, empty queue assigned to the authenticated user. Any older queue with the same assignee stops being returned by GET /current (the newest… - [Reassign queue](https://www.withallo.com/docs/dialing-queues/assign-queue.md): Reassigns a dialing queue to another member of the team. The queue keeps its numbers and its creator. Only API keys of a team admin or manager can call this… ## API: Partners - [Overview](https://www.withallo.com/docs/partner/overview.md): Create, price and deactivate Allo accounts for your customers from your own software, as a partner who resells Allo. - [Get account price](https://www.withallo.com/docs/partner/get-price.md): Returns what Allo will charge you for a new account at the chosen billing interval: the Business plan price in your billing currency, with your partner… - [Create account](https://www.withallo.com/docs/partner/create-account.md): Creates an Allo account for one of your customers, provisions a phone number, and returns a scoped API key for the account. Requires the PARTNER scope and a… - [Get account](https://www.withallo.com/docs/partner/get-account.md): Returns the status and activation state of an account you provisioned, including whether it is suspended. Requires the PARTNER scope. - [Deactivate account](https://www.withallo.com/docs/partner/delete-account.md): Deactivates an account you provisioned and cancels its subscription, so it is not renewed. The account stays active until the end of the current paid period… - [Get prepaid credit](https://www.withallo.com/docs/partner/get-credit.md): Returns the prepaid credit you have left and your recent top-ups. Allo pays what you buy through the Partner API from this credit first, then charges your… ## API: White label - [Overview](https://www.withallo.com/docs/white-label/overview.md): Run your own product on Allo's API: manage the members, numbers, eSIMs, suspensions and sender IDs of the accounts you create, under your brand. - [Suspend account](https://www.withallo.com/docs/white-label/suspend-account.md): Suspends an account you provisioned, right away. Inbound and outbound calls, outgoing SMS and the AI receptionist stop for every member of the account: each… - [Resume account](https://www.withallo.com/docs/white-label/resume-account.md): Resumes a suspended account: everything the suspension stopped works again, including its eSIM lines. Idempotent: resuming an account that is not suspended… - [Get number price](https://www.withallo.com/docs/white-label/get-number-price.md): Returns what adding one more number to the account costs today. When the account already pays for a free number slot, included is true and amount due now is… - [Add number](https://www.withallo.com/docs/white-label/add-number.md): Adds a phone number to one of your accounts. The number is billed on the account's subscription, which you pay: Allo draws on your prepaid credit first, then… - [Add member](https://www.withallo.com/docs/white-label/add-member.md): Adds a member to one of your accounts, with a phone number of their own: a new number from number preference , or a number the account already holds from… - [List members](https://www.withallo.com/docs/white-label/list-members.md): Lists the members of one of your accounts, oldest first. The account itself is not in the list. Requires the PARTNER scope. - [Remove member](https://www.withallo.com/docs/white-label/remove-member.md): Removes a member from one of your accounts. Allo revokes the member's eSIMs first, so their phone stops ringing right away, then removes the member from the… - [Get eSIM offer](https://www.withallo.com/docs/white-label/get-esim-offer.md): Returns the eSIM setup fee, the data tiers you can order and the data top-ups you can buy for an account you provisioned, priced on the subscription you pay… - [Order eSIM](https://www.withallo.com/docs/white-label/order-esim.md): Orders an eSIM for one of the account's numbers. The setup fee and the first period of the tier are charged on the subscription you pay for the account: Allo… - [Change eSIM tier](https://www.withallo.com/docs/white-label/change-esim-tier.md): Moves an eSIM to another data tier. An upgrade is charged now, prorated for the rest of the billing period: Allo draws on your prepaid credit first, then… - [Buy eSIM top-up](https://www.withallo.com/docs/white-label/buy-esim-topup.md): Buys a data top-up for an eSIM. The top-up is charged once: Allo draws on your prepaid credit first, then charges your card on file. Its data is added to the… - [Get eSIM](https://www.withallo.com/docs/white-label/get-esim.md): Returns the status of an eSIM you ordered, its current tier and, once it is ACTIVE , its mobile data use this month. Use it to poll for readiness if you do… - [Get eSIM activation code](https://www.withallo.com/docs/white-label/get-esim-activation-code.md): Returns the activation code of a ready eSIM: the LPA string, the SM-DP+ address, the matching id and a QR code. Before the eSIM is ready, the request fails… - [Revoke eSIM](https://www.withallo.com/docs/white-label/revoke-esim.md): Revokes an eSIM right away: it stops working on its phone for good. The number stays on the account, keeps its history and rings the Allo apps instead. The… - [Declare sender ID](https://www.withallo.com/docs/white-label/create-sender-id.md): Declares an alphanumeric sender ID on one of your accounts, so the account can send SMS under that name. The sender ID is created with status PENDING and… - [List sender IDs](https://www.withallo.com/docs/white-label/list-sender-ids.md): Lists the sender IDs declared on one of your accounts, with their review status. Requires the PARTNER scope. - [Get sender ID](https://www.withallo.com/docs/white-label/get-sender-id.md): Returns a sender ID declared on one of your accounts, with its review status. Use it to poll the status if you do not receive webhooks, and to see whether…