latestOpenAPI 3.0.02026-08-10416661.5 MB

e96b3e58b041

Keywords

Get keyword contacts

REQUIRED SCOPES <code>['keywords:read']</code><br>Get keyword contacts

get/keywords/{keyword}/contacts

Path parameters

keywordstring required

The ID of the keyword

Query parameters

pageinteger

The page of a collection to return.

limitinteger

The number of items to return per page.

termstring

Search term

filter'subscribed' | 'opted_out'

Filter

fromstring date required

Start date for the statistics range (YYYY-MM-DD)

tostring date required

Start date for the statistics range (YYYY-MM-DD)

Response

OK

idinteger

Returns the contact in array format.

owner_idinteger
colorstring
first_namestring
last_namestring
full_namestring
emailstring
photo_urlstring
numberstring
countrystring
country_calling_codestring
national_numberstring
typeted_numberstring
is_blockedboolean
opt_outboolean
opt_out_atstring
opt_in_request_atstring
opt_in_atstring
created_atstring
updated_atstring
integration_vendor_idinteger
prevent_autolinkboolean