Contacts

List contacts

Cursor-paginated, newest first. Filters combine with AND. Requires the read scope.

get/contacts

Request

  • Base URL: https://sumgenius.ai/api/v1
  • URL: https://sumgenius.ai/api/v1/contacts
  • Auth: one of:
    • API key in header X-SumGenius-Api-Key
    • HTTP bearer

Query parameters

channel'facebook' | 'instagram' | 'sms' | 'telegram' | 'whatsapp'

Channel the contact was seen on.

stage'new' | 'contacted' | 'qualified' | 'customer' | 'lost'

Pipeline stage.

tagstring

Exact tag name the contact carries.

emailstring

Exact email match.

phonestring

Exact phone match.

namestring

Substring match on the display name.

updated_sincestring date-time

ISO-8601 UTC. Contacts updated at or after this time.

limitinteger

Page size, 1 to 100. Default 25.

starting_afterstring

The next_cursor from the previous page.

Response

A page

has_moreboolean required
next_cursorstring nullable required

Pass as starting_after for the next page. Null on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.