# Allo — Help Center: English API Reference > Documentation and support for Allo, the business phone system that does the work your calls create ## API Reference ### API - [Overview](https://help.withallo.com/en/v2/api-reference/introduction.md): Integrate Allo's communication capabilities into your applications - [Authentication](https://help.withallo.com/en/v2/api-reference/guides/authentication.md): Authenticate API requests using API keys - [Rate limits](https://help.withallo.com/en/v2/api-reference/guides/rate-limits.md): Request limits and response headers - [Pagination](https://help.withallo.com/en/v2/api-reference/guides/pagination.md): Page-based pagination with total counts on all list endpoints - [Error handling](https://help.withallo.com/en/v2/api-reference/guides/error-handling.md): Standardized error responses with actionable suggestions - [Error codes](https://help.withallo.com/en/v2/api-reference/guides/error-codes.md): Complete catalog of all API error codes with recovery instructions - [Common use cases](https://help.withallo.com/en/v2/api-reference/guides/common-use-cases.md): Examples of how to use the Allo API to answer business questions and automate workflows ### Webhooks - [Overview](https://help.withallo.com/en/v2/api-reference/webhooks/overview.md): Receive real-time notifications when events occur in your Allo account - [List webhooks](https://help.withallo.com/en/v2/api-reference/webhooks/get-webhooks.md): Returns all webhook endpoints configured for your account. - [Get webhook](https://help.withallo.com/en/v2/api-reference/webhooks/get-webhook.md): Returns a single webhook endpoint by ID, including its `signing_secret`. - [Create webhook](https://help.withallo.com/en/v2/api-reference/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 signatures. - [Update webhook](https://help.withallo.com/en/v2/api-reference/webhooks/update-webhook.md): Updates a webhook endpoint. Only the fields you provide are changed. Omitted fields are left untouched. - [Delete webhook](https://help.withallo.com/en/v2/api-reference/webhooks/delete-webhook.md): Permanently deletes a webhook endpoint and its delivery history. - [List event types](https://help.withallo.com/en/v2/api-reference/webhooks/list-event-types.md): Returns the catalog of event topics you can subscribe a webhook to. - [Event catalog](https://help.withallo.com/en/v2/api-reference/webhooks/event-catalog.md): Full reference for all webhook event types and their payloads - [Verifying webhook signatures](https://help.withallo.com/en/v2/api-reference/webhooks/verifying-signatures.md): Authenticate incoming webhooks using HMAC-SHA256 signatures - [Delivery and retries](https://help.withallo.com/en/v2/api-reference/webhooks/delivery-and-retries.md): How Allo delivers webhooks, retries failures, and handles recovery - [Testing webhooks](https://help.withallo.com/en/v2/api-reference/webhooks/testing.md): Test your webhook endpoints before going live - [Best practices](https://help.withallo.com/en/v2/api-reference/webhooks/best-practices.md): Recommendations for building reliable webhook consumers - [Troubleshoot](https://help.withallo.com/en/v2/api-reference/webhooks/troubleshooting.md): Diagnose and fix common webhook delivery issues ### Conversations - [Overview](https://help.withallo.com/en/v2/api-reference/conversations/overview.md): Unified call and SMS history with keyword search and rich filtering - [List conversations](https://help.withallo.com/en/v2/api-reference/conversations/list-conversations.md): Returns a paginated list of conversations grouped by contact phone number, sorted by most recent activity. - [Get conversation item](https://help.withallo.com/en/v2/api-reference/conversations/get-item.md): Returns a single call or SMS message by its ID. - [Get recording download link](https://help.withallo.com/en/v2/api-reference/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 may hear the call. Only a user who can play the recording in Allo gets one, and never for a call on a HIPAA-enabled team. - [Search conversation items](https://help.withallo.com/en/v2/api-reference/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://help.withallo.com/en/v2/api-reference/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 the analytics drilldown or any other list. - [Execute conversation action](https://help.withallo.com/en/v2/api-reference/conversations/execute-action.md): Execute an action on a conversation. - [Update call summary](https://help.withallo.com/en/v2/api-reference/conversations/update-summary.md): Replace the markdown content of a call's AI-generated summary. ### CRM - [Overview](https://help.withallo.com/en/v2/api-reference/crm/overview.md): Manage people, companies, and deals in your Allo CRM ### People - [Overview](https://help.withallo.com/en/v2/api-reference/crm/people-overview.md): Manage people in your Allo CRM - [Get person](https://help.withallo.com/en/v2/api-reference/crm/get-person.md): Returns a single person by ID. - [Create person](https://help.withallo.com/en/v2/api-reference/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_ATTRIBUTE_KEY_UNKNOWN`, and a value of the wrong type returns `400 CUSTOM_ATTRIBUTE_VALUE_INVALID`. - [Update person](https://help.withallo.com/en/v2/api-reference/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 attribute returns `400 CUSTOM_ATTRIBUTE_KEY_UNKNOWN`, and a value of the wrong type returns `400 CUSTOM_ATTRIBUTE_VALUE_INVALID`. - [Search people](https://help.withallo.com/en/v2/api-reference/crm/search-people.md): Search and filter people in your CRM with advanced filtering, sorting, and pagination. ### Custom fields - [Overview](https://help.withallo.com/en/v2/api-reference/crm/attributes-overview.md): Manage custom contact fields in your Allo CRM - [List custom fields](https://help.withallo.com/en/v2/api-reference/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 integrations. Archived fields and built-in fields such as name or company are not listed. - [Create custom field](https://help.withallo.com/en/v2/api-reference/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 the same type again returns the existing field with `already_existed` set to `true`. Creating a label that matches a deleted field restores… - [Update custom field](https://help.withallo.com/en/v2/api-reference/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 edited. - [Delete custom field](https://help.withallo.com/en/v2/api-reference/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` returns `CUSTOM_ATTRIBUTE_KEY_UNKNOWN`. The stored values are kept, and creating a field with the same label and type restores it with them. Built… ### Companies - [Overview](https://help.withallo.com/en/v2/api-reference/crm/companies-overview.md): Manage companies in your Allo CRM - [Get company](https://help.withallo.com/en/v2/api-reference/crm/get-company.md): Returns a single company by ID. - [Create company](https://help.withallo.com/en/v2/api-reference/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_ATTRIBUTE_KEY_UNKNOWN`, and a value of the wrong type returns `400 CUSTOM_ATTRIBUTE_VALUE_INVALID`. - [Update company](https://help.withallo.com/en/v2/api-reference/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 attribute returns `400 CUSTOM_ATTRIBUTE_KEY_UNKNOWN`, and a value of the wrong type returns `400 CUSTOM_ATTRIBUTE_VALUE_INVALID`. - [Search companies](https://help.withallo.com/en/v2/api-reference/crm/search-companies.md): Search and filter companies in your CRM. - [List company attributes](https://help.withallo.com/en/v2/api-reference/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 listed. Only available to teams on the new contact model. - [Create company attribute](https://help.withallo.com/en/v2/api-reference/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 already exists, it returns `201` with that attribute and `already_existed` set to `true`. `options` is required for `DROPDOWN` attributes and rej… - [Update company attribute](https://help.withallo.com/en/v2/api-reference/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`, `should_prompt_override` and `is_visible`. - [Delete company attribute](https://help.withallo.com/en/v2/api-reference/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. ### Deals - [Overview](https://help.withallo.com/en/v2/api-reference/crm/deals-overview.md): Access deals synced from your CRM integrations - [Search deals](https://help.withallo.com/en/v2/api-reference/crm/search-deals.md): Search and filter deals in your CRM. - [Get deal](https://help.withallo.com/en/v2/api-reference/crm/get-deal.md): Returns a single deal by ID. ### Notes - [Overview](https://help.withallo.com/en/v2/api-reference/notes/overview.md): Internal team notes on conversations and person profiles, with @mentions - [List conversation notes](https://help.withallo.com/en/v2/api-reference/notes/list-conversation-notes.md): Returns the internal team notes on a conversation, paginated. - [Create conversation note](https://help.withallo.com/en/v2/api-reference/notes/create-conversation-note.md): Adds an internal team note to a conversation. Notes are never visible to the contact. - [Get conversation note](https://help.withallo.com/en/v2/api-reference/notes/get-conversation-note.md): Returns a single conversation note by ID. - [Update conversation note](https://help.withallo.com/en/v2/api-reference/notes/update-conversation-note.md): Updates a note's content. Only the note's author can edit it. - [Delete conversation note](https://help.withallo.com/en/v2/api-reference/notes/delete-conversation-note.md): Deletes a note. Only the note's author can delete it. - [List person notes](https://help.withallo.com/en/v2/api-reference/notes/list-person-notes.md): Returns the notes on a person's CRM profile, paginated. - [Create person note](https://help.withallo.com/en/v2/api-reference/notes/create-person-note.md): Adds a note to a person's CRM profile. - [Update person note](https://help.withallo.com/en/v2/api-reference/notes/update-person-note.md): Updates a person note's content. Only the note's author can edit it. - [Delete person note](https://help.withallo.com/en/v2/api-reference/notes/delete-person-note.md): Deletes a person note. Only the note's author can delete it. ### Threads - [Overview](https://help.withallo.com/en/v2/api-reference/threads/overview.md): Team discussion threads attached to calls, SMS, and conversation notes - [Get thread](https://help.withallo.com/en/v2/api-reference/threads/get-thread.md): Returns a thread with all its comments. - [Find thread](https://help.withallo.com/en/v2/api-reference/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://help.withallo.com/en/v2/api-reference/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://help.withallo.com/en/v2/api-reference/threads/create-comment.md): Adds a comment to an existing thread. - [Update thread comment](https://help.withallo.com/en/v2/api-reference/threads/update-comment.md): Updates a comment's content. Only the comment's author can edit it. - [Resolve thread](https://help.withallo.com/en/v2/api-reference/threads/resolve-thread.md): Marks a thread as resolved. - [Unresolve thread](https://help.withallo.com/en/v2/api-reference/threads/unresolve-thread.md): Reopens a resolved thread. ### Phone Numbers - [Overview](https://help.withallo.com/en/v2/api-reference/phone-numbers/overview.md): Access your Allo phone numbers, sender IDs, and their capabilities - [List phone numbers](https://help.withallo.com/en/v2/api-reference/phone-numbers/list-numbers.md): Returns all phone numbers and sender IDs on your team. - [Get call flow](https://help.withallo.com/en/v2/api-reference/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 `?status=draft` to return the working draft instead. - [Get call flow draft](https://help.withallo.com/en/v2/api-reference/phone-numbers/get-call-flow-draft.md): Returns the working draft of a phone number's call flow. Unlike `GET /v2/api/numbers/{number}/call_flow?status=draft`, this endpoint does NOT fall back to the published flow when no draft exists — it returns `404 CALL_FLOW_DRAFT_NOT_FOUND`. Use it to read a draft's `lock_version` without risk of acc… - [Save call flow draft](https://help.withallo.com/en/v2/api-reference/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: pass the `lock_version` returned by a previous read to detect a concurrent edit, and `base_published_version` to detect a publish that happene… - [Publish call flow](https://help.withallo.com/en/v2/api-reference/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 stricter than the lenient validation a draft save runs, so a draft that saved successfully can still fail to publish; the whole publish rolls… ### AI Receptionist - [Overview](https://help.withallo.com/en/v2/api-reference/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://help.withallo.com/en/v2/api-reference/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 rules, connected calendars and knowledge sources. Call this before a write, because `PATCH` replaces whole collections. - [Update configuration](https://help.withallo.com/en/v2/api-reference/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 receptionist on the line: that is `PUT /v2/api/numbers/{number}/agent/status`. - [Set prompt](https://help.withallo.com/en/v2/api-reference/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 sections with `GET /v2/api/numbers/{number}/agent` and send them all back, including the ones you are not changing. Facts about the business belong… - [Turn on or off](https://help.withallo.com/en/v2/api-reference/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 line routes real calls, so confirm with a person before calling it. - [Add website knowledge](https://help.withallo.com/en/v2/api-reference/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 answer from it once indexing has finished. A crawl failure is not reported back. If another line of the team already added the URL, the existing… - [Enable or disable a website](https://help.withallo.com/en/v2/api-reference/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 to this line. - [Delete website knowledge](https://help.withallo.com/en/v2/api-reference/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://help.withallo.com/en/v2/api-reference/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 deletes them. - [List calendars](https://help.withallo.com/en/v2/api-reference/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, a team member only the ones they connected. Connecting a calendar is an OAuth flow done in the Allo app. - [Get a calendar](https://help.withallo.com/en/v2/api-reference/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 filling `scheduling.calendars`. - [List voices](https://help.withallo.com/en/v2/api-reference/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 is listed under. ### Tags - [Overview](https://help.withallo.com/en/v2/api-reference/tags/overview.md): Discover available call tags for filtering conversations - [List tags](https://help.withallo.com/en/v2/api-reference/tags/list-tags.md): Returns all tags configured on the team. - [Create tag](https://help.withallo.com/en/v2/api-reference/tags/create-tag.md): Creates a new tag on the team. The tag key is auto-generated by slugifying the name. - [Delete tag](https://help.withallo.com/en/v2/api-reference/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://help.withallo.com/en/v2/api-reference/tags/add-tags.md): Add one or more tags to a conversation item. - [Remove tag](https://help.withallo.com/en/v2/api-reference/tags/remove-tag.md): Remove a tag from a conversation item. ### Summary Templates - [Overview](https://help.withallo.com/en/v2/api-reference/summary-templates/overview.md): Manage the call summary templates that shape AI-generated call summaries - [List summary templates](https://help.withallo.com/en/v2/api-reference/summary-templates/list-summary-templates.md): Returns the team's call summary templates. - [Get summary template](https://help.withallo.com/en/v2/api-reference/summary-templates/get-summary-template.md): Returns a single call summary template by ID. - [Create summary template](https://help.withallo.com/en/v2/api-reference/summary-templates/create-summary-template.md): Creates a call summary template for the team. - [Update summary template](https://help.withallo.com/en/v2/api-reference/summary-templates/update-summary-template.md): Replaces a summary template's name, call context, icon, and sections. - [Delete summary template](https://help.withallo.com/en/v2/api-reference/summary-templates/delete-summary-template.md): Soft-deletes (deactivates) a summary template. - [Set a number's default template](https://help.withallo.com/en/v2/api-reference/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. ### Users - [Overview](https://help.withallo.com/en/v2/api-reference/users/overview.md): Access your team roster with roles and status - [Me](https://help.withallo.com/en/v2/api-reference/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 key can call this endpoint. - [List users](https://help.withallo.com/en/v2/api-reference/users/list-users.md): Returns all team members. - [Get user](https://help.withallo.com/en/v2/api-reference/users/get-user.md): Returns a single team member by their ID. ### SMS - [Overview](https://help.withallo.com/en/v2/api-reference/sms/overview.md): Send SMS and MMS messages programmatically - [Send SMS](https://help.withallo.com/en/v2/api-reference/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://help.withallo.com/en/v2/api-reference/sms/send-sms-france.md): Send an SMS message to a French phone number using a verified Sender ID. The Sender ID must be verified by the Allo team before use. Contact support to register your Sender ID. ### Analytics - [Overview](https://help.withallo.com/en/v2/api-reference/analytics/overview.md): Pre-computed call metrics and team performance analytics - [Team metrics](https://help.withallo.com/en/v2/api-reference/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://help.withallo.com/en/v2/api-reference/analytics/outbound.md): Returns outbound call metrics: dial funnel (dials → connected → conversations → conversions), time series, heatmap, leaderboard, and time spent metrics. ### Power Dialer - [Overview](https://help.withallo.com/en/v2/api-reference/dialing-queues/overview.md): Manage Power Dialer queues programmatically - [List current queue numbers](https://help.withallo.com/en/v2/api-reference/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 numbers (use `page`/`size` and read `pagination` to page through them); the `queue` key carries the queue's metadata (id, name, settings) w… - [Upsert current queue](https://help.withallo.com/en/v2/api-reference/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 both are provided. - [Append numbers](https://help.withallo.com/en/v2/api-reference/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 append to a teammate's queue — if that teammate has no current queue, one is created with the API key owner as `creator_id` and the teammate a… - [Clear queue numbers](https://help.withallo.com/en/v2/api-reference/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 index), `number` + `position` together (delete a specific occurrence of a duplicate), or `unassigned=true` (remove every entry that has not b… - [Reset current queue](https://help.withallo.com/en/v2/api-reference/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 queue wins). Send `user_id` or `email` to create the queue for a teammate instead — the API key owner is recorded as `creator_id`, the teammate a… ### Partner - [Overview](https://help.withallo.com/en/v2/api-reference/partner/overview.md): Create and manage Allo accounts for your customers from your own software, as a Discounted licence (reseller) partner. - [Get account price](https://help.withallo.com/en/v2/api-reference/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 discount applied. The full amount is charged when the account is created, with no proration. Amounts are in the smallest currency unit (e.g. cents).… - [Create account](https://help.withallo.com/en/v2/api-reference/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 Discounted licence (reseller) partner contract. The account gets its own Business plan subscription, billed to you at the chosen `interval` w… - [Get account](https://help.withallo.com/en/v2/api-reference/partner/get-account.md): Returns the status and activation state of an account you provisioned. Requires the `PARTNER` scope. - [Deactivate account](https://help.withallo.com/en/v2/api-reference/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, then expires. Requires the `PARTNER` scope. - [Get number price](https://help.withallo.com/en/v2/api-reference/partner/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 `0`. Otherwise `amount_due_now` is the charge for the rest of the account's current billing period, net of the subscription's discount, t… - [Add number](https://help.withallo.com/en/v2/api-reference/partner/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 charges your card on file for the rest. When the account already pays for a number slot that no number uses, the new number takes that slot an… - [Add member](https://help.withallo.com/en/v2/api-reference/partner/add-member.md): Adds a member to one of your accounts, with a phone number of their own. The member takes a seat the account already pays for and no one uses, or one more seat on the account's subscription, which you pay: Allo draws on your prepaid credit first, then charges your card on file for the rest. The seat… - [List members](https://help.withallo.com/en/v2/api-reference/partner/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. - [Get prepaid credit](https://help.withallo.com/en/v2/api-reference/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 card on file for the rest. Without enough credit and without a card, a request that charges fails with `402 PARTNER_CREDIT_INSUFFICIENT` and noth… - [Get eSIM offer](https://help.withallo.com/en/v2/api-reference/partner/get-esim-offer.md): Returns the eSIM setup fee and the data tiers you can order for an account you provisioned, priced on the subscription you pay for that account: its currency, its billing interval and your partner discount. Amounts are in the smallest currency unit (e.g. cents). Requires the `PARTNER` scope. - [Order eSIM](https://help.withallo.com/en/v2/api-reference/partner/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 draws on your prepaid credit first, then charges your card on file for the rest. The eSIM is returned with status `PROVISIONING` and is usuall… - [Get eSIM](https://help.withallo.com/en/v2/api-reference/partner/get-esim.md): Returns the status of an eSIM you ordered. Use it to poll for readiness if you do not receive webhooks. Requires the `PARTNER` scope. - [Get eSIM activation code](https://help.withallo.com/en/v2/api-reference/partner/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 with `ESIM_NOT_READY`. Requires the `PARTNER` scope. ## OpenAPI Specs - [openapi](/openapi.json)