« Back to Documentation OverviewcampaignMembers – v1.3
campaignMembers(string apikey, string cid, string status, int start, int limit)
Get all email addresses the campaign was successfully sent to (ie, no bounces)
| Parameters | | apikey | a valid API Key for your user account. Get by visiting your API dashboard |
| cid | the campaign id to pull members for (can be gathered using campaigns()) |
| status | optional - the status to pull - one of 'sent', 'hard' (bounce), or 'soft' (bounce). By default, all records are returned |
| start | optional - for large data sets, the page number to start at - defaults to 1st page of data (page 0) |
| limit | optional - for large data sets, the number of results to return - defaults to 1000, upper limit set at 15000 |
| Returns | | array |
a total of all matching emails and the specific emails for this page
| int | total | the total number of members for the campaign and status
| | array | data | the full campaign member records
| string | email | the email address sent to
| | string | status | the status of the send - one of 'sent', 'hard', 'soft'
| | string | absplit_group | if this was an absplit campaign, one of 'a','b', or 'winner'
| | string | tz_group | if this was an timewarp campaign the timezone GMT offset the member was included in
| | |