CLcleverreach
groups

return receivers. 🔐

return a list of receivers

post/v3/groups/{group_id}/get_receivers

Request

  • Base URL
    https://rest.cleverreach.com
  • URL
    https://rest.cleverreach.com/v3/groups/{group_id}/get_receivers
  • Auth
    API key in header Authorization

Path parameters

group_idstring required

Group ID

Request body

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

Response

Success

string[] required

Changes

No recorded changes to this operation across all 4 revisions of this API.