Skip to main content
GET
Estimate assistant or Loop phone rates

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Query Parameters

context
enum<string>
default:loop

Choose assistant phone service or Loop calling.

Available options:
loop,
assistant
country
string

Two-letter country code. Incoming: receiving number country. Outgoing: destination country. Omit for the country list.

Pattern: ^[A-Za-z]{2}$
direction
enum<string>
default:outbound
Available options:
inbound,
outbound

Response

Available countries or workspace-specific estimates.

data
object
required