1
Create a scoped key
Sign in to API keys. Create a purpose-specific key with
data:read. Add contacts:read only if your integration needs permitted contact fields. Copy the secret when it is shown and store it in your application’s secret manager.2
Set your local environment
Provide the key outside source control. Do not paste a real key into shared prompts, issues, example files or URLs.
3
Check account access
data and meta.request_id. Save the request ID when troubleshooting.4
Search carriers
data and the source metadata in meta. If the response includes next_cursor, send it with the same filters to request the next page. An empty page is a valid result.Continue your integration
Use carrier search for filters and cursor recovery. Use exports when you need a pinned CSV rather than many interactive pages. See errors for401, 402, 403 and retry behavior.