Chat icon

Chat

Interact with the Chat API

Actions253

Contact → List

AI-generated

Summary

Lists contacts from the selected Approach account with pagination, sorting, and optional inbox details.

Inputs

  • accountId (required) — Select the Approach account to query.
  • page — Page number to retrieve (default: 1).
  • sort — Field to sort contacts by (default: last_activity_at). Options: city, company_name, country, created_at, email, last_activity_at, name.
  • sortOrder — Sort order (default: desc). Options: asc, desc.
  • includeContactInboxes — When true, includes inbox information for each contact (default: false).

Output shape

array of contact objects

Each contact contains standard fields such as id, name, email, etc. If includeContactInboxes is true, each contact also includes an inboxes array.

Links

Discussion