Reminder: As of August 9th, the demo API key will only be allowed to make GET requests. Please see the announcement for more details.

Get all campaign IDs for a portal

Last updated February 21, 2019

GET /email/public/v1/campaigns/by-id

Method Details

HTTP Methods:


Response Format:


Requires Authentication?


Rate Limited?






Required Scope:


For a given portal, return all email campaign IDs associated with the portal. The email campaign IDs are returned in no particular order. You can then use the IDs to look up data on the performance of each marketing email campaign.

Note that you can get campaign IDs with recent activity via this endpoint instead.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.
Optional Parameters How to use Description
Offset offset=X - Used in the request URL A key representing which page of results you would like.
Limit limit=X - Used in the request URL Limit the maximum number of results you would like returned.

Example URL: