groups
return receivers. π
Changed onreturn a list of receivers
get/v3/groups/{group_id}/receivers
Request
- Base URLhttps://rest.cleverreach.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
group_idstring required
Group ID
Query parameters
pagesizeinteger
Pagesize (max 5000)
pageinteger
Page (zero-based)
type'all' | 'active' | 'inactive' | 'bounce' | 'softbounce' | 'hardbounce'
Type
detailinteger
Detail depth (bitwise combinable) (0: none, 1: events, 2: orders, 4: tags)
email_liststring
list of receiver emails to filter for. Comma separated like: "foo@bar.com,bar@foo.com,..."
id_liststring
list of Receiver ID's to filter for. comma separated like: "123,633,5342"
order_bystring
field to order by, append 'asc' or 'desc' with a space
last_idinteger
keyset paging: only receivers with an ID higher than this one, ordered by ID; page is ignored (default: 0 = off)
Response
Success
string[] required
Changes
- info
added the new optional
queryrequest parameterlast_id
- info