Contacts

List contacts

Get a list of contacts for a specific org.

get/orgs/contacts

Request

Base URL: https://api.useinvent.com
URL: https://api.useinvent.com/orgs/contacts
Auth: HTTP bearer

Query parameters

searchstring

Free-text filter over contact name and channels.

unsubscribedboolean

Whether the contact is unsubscribed

user_idstring

Search contacts by user ID match

namestring

Search contacts by name match

usernamestring

Search contacts by username match

emailstring email

Search contacts by email match

segment_idstring

Search contacts by segment ID match

exclude_adminsboolean

Exclude admin contacts

status'ALL' | 'SUBSCRIBED' | 'UNSUBSCRIBED' | 'BLOCKED' | 'AI_REPLIES_OFF'

Only contacts with this subscription status.

pagenumber

Page number

takenumber

Number of items to take

nextstring

Next page token (Only used on special endpoints)

progressiveboolean

Skip the total count: pagination-count is exact on the last page, and one more than the items so far while more pages exist (Only used on special endpoints)

Response

idstring required

namestring nullable required

blockedboolean required

blocked_atstring date-time

unsubscribedboolean required

unsubscribed_atstring date-time

unsubscribe_reasonstring

unsubscribe_feedbackstring

ai_repliesboolean required

ai_replies_atstring date-time

is_adminboolean required

fieldsobject required

Map of contact field key → value.

created_atstring date-time required

updated_atstring date-time required

Changes

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