Skip to content

Accounts‐Getters

briansemify edited this page Oct 20, 2025 · 3 revisions

Accounts — Retrieval Endpoints

All endpoints require Authorization header.

All Accounts

  • GET /api/v2/accounts
  • Supports pagination. Check pagination in response.

Get by Account ID

  • GET /api/v2/accounts/{account_id}
  • Returns full account object including attributes, linked campaigns.

Get by Custom Field

  • Use query params or specialized endpoints (check API reference for exact param names).
  • Example: GET /api/v2/accounts?attributeField=Industry&attributeValue=Technology

Response notes

  • Pagination object: maxRows, totalPages, offset, page, totalRecords
  • If referenced, campaign objects will contain campaign_id and account_id.

Use cases

  • Synchronizing your CRM -> poll for new accounts
  • Searching by external_account_identifier for idempotent account creation

Clone this wiki locally