Methods
List
ListWithContext
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 identifieremail(string): Email addressobject(string): Object typefirst_name(string): First namelast_name(string): Last namecreated_at(string): Creation timestampunsubscribed(bool): Unsubscribe statusproperties(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
AudienceIdto list global contacts - Include
AudienceIdto list audience-specific contacts - Use
Limit,After, andBeforefor pagination - The
HasMorefield indicates if additional pages are available