Request checklist
1
Send authentication on every request
Include
Authorization: Bearer sk_your_api_key. Treat 401 Unauthorized as a key or account configuration issue.2
Use pagination consistently
Always pass
page and pageSize for list endpoints. Do not assume all records fit in the first response.3
Check credits before paid actions
Use
GET /external/credits/balance before event unlocks, email unlocks, or exhibitor event searches.4
Precheck when the next action depends on access state
Use
POST /external/actions/precheck before workflows where you need to know whether an action is allowed, whether it should charge credits, or which unlock path applies.5
Make asynchronous jobs resumable
Store
task_id from contact unlock responses so polling can continue after page refreshes, worker restarts, or network failures.6
Handle item-level async outcomes
Treat a terminal task as complete for the job, then inspect each item result before counting delivered emails or failed contacts.
7
Back off on rate limits
Respect
Retry-After for 429 Too Many Requests and use X-RateLimit-* headers for proactive throttling.Error handling matrix
Credit-safe UI pattern
For credit-consuming actions, use a two-step confirmation pattern:- Show what the user is about to unlock or search.
- Show the expected credit cost when known.
- Check current balance.
- Ask the user to confirm.
- Execute the API call.
- Refresh balance and result state.
- Reconcile final billing against the post-action balance and task or endpoint response.
Credit-consuming actions
Read-only list, profile, search, and precheck endpoints do not spend credits by themselves.
Rate-limit friendly polling
For contact unlock tasks, avoid tight polling loops.Logging and support
Log enough context to investigate issues without storing sensitive data:- endpoint path and method
- response status
traceIdfrom error responses when availableX-Request-IDif your client sends one- task ID for asynchronous jobs
- event or personnel identifiers involved in the workflow
Related concepts
Authentication
How to authenticate API requests.
Error conventions
Shared error response shape and tracing fields.
Pagination conventions
Standard pagination fields and page-size limits.
Rate limits
Headers, retry behavior, and integration guidance.