Skip to main content

Methods

List

Retrieves a list of contacts.

ListWithContext

Retrieves a list of contacts with context support.

Parameters

ListContactsOptions

string
Optional - Omit for global contacts. Include to list audience-specific contacts.
*int
Maximum number of contacts to return per page
*string
Cursor for pagination - retrieve results after this cursor
*string
Cursor for pagination - retrieve results before this cursor

Response

ListContactsResponse

string
Object type (“list”)
[]Contact
Array of contact objects. Each contact contains:
  • id (string): Contact identifier
  • email (string): Email address
  • object (string): Object type
  • first_name (string): First name
  • last_name (string): Last name
  • created_at (string): Creation timestamp
  • unsubscribed (bool): Unsubscribe status
  • properties (map[string]any): Custom properties (global contacts only)
bool
Whether there are more results available for pagination

Examples

List All Global Contacts

List with Pagination

List Audience Contacts

Paginate Through All Contacts

Notes

  • Omit AudienceId to list global contacts
  • Include AudienceId to list audience-specific contacts
  • Use Limit, After, and Before for pagination
  • The HasMore field indicates if additional pages are available