Skip to content

list_contacts

List contacts in the workspace, optionally searched (email + name) or filtered by plan. Sort by created, last_seen, or mrr. Cursor pagination.

required scope: read.

  • “show me my top-MRR contacts on the Pro plan.”
  • “find every contact whose email starts with ‘acme’.”
  • “list the 20 most recently seen customers.”
fieldtyperequirednotes
qstring (max 200 chars)noSearch email + name (ILIKE).
sortenum (created, last_seen, mrr)noDefault: created.
planstring[] (min 1)noExact-match plan filter, e.g. [“pro”,“team”].
cursorstringno
limitinteger (1-100)no
  • The plan filter accepts a single value or an array; matches are exact (case-sensitive).
  • mrr sort places contacts with null mrr at the end of the result set (NULLS LAST).

{ "data": [Contact, ...], "nextCursor": "..." | null }.