Skip to main content
POST
Discover CRM objects and fields

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, 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.

Body

application/json
connection_id
string<uuid>
required
object_type
string
selection
object

Provider-neutral source selection. sourceId limits the source; default_phone_country is an optional ISO-2 fallback for national phone numbers.

field_mapping
object

Source key or composed source expression to destination. Combined values use non-evaluated {{field}} tokens plus optional literal text, for example {{salutation}} {{firstName}} {{lastName}}.

include_preview
boolean
default:false
preview_limit
integer
default:3
Required range: 1 <= x <= 5

Response

Objects, or fields and sources with optional mapped sample records.