Get Campaign Campaign Messages

GET {{baseUrl}}/api/campaigns/:id/campaign-messages/

Return all messages that belong to the given campaign.

Rate limits:
Burst: 10/s
Steady: 150/m

Scopes: campaigns:read

Request Params

HEADERS

RESPONSES

status: OK

{"data":[{"type":"campaign-message","id":"\u003cstring\u003e","attributes":{"label":"\u003cstring\u003e","channel":"\u003cstring\u003e","content":{"subject":"\u003cstring\u003e","preview_text":"\u003cstring\u003e","from_email":"\u003cstring\u003e","from_label":"\u003cstring\u003e","reply_to_email":"\u003cstring\u003e","cc_email":"\u003cstring\u003e","bcc_email":"\u003cstring\u003e"},"send_times":[{"datetime":"\u003cdateTime\u003e","is_local":"\u003cboolean\u003e"},{"datetime":"\u003cdateTime\u003e","is_local":"\u003cboolean\u003e"}],"render_options":{"shorten_links":true,"add_org_prefix":true,"add_info_link":true,"add_opt_out_language":false},"created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"campaign":{"data":{"type":"campaign","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"template":{"data":{"type":"template","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}},{"type":"campaign-message","id":"\u003cstring\u003e","attributes":{"label":"\u003cstring\u003e","channel":"\u003cstring\u003e","content":{"subject":"\u003cstring\u003e","preview_text":"\u003cstring\u003e","from_email":"\u003cstring\u003e","from_label":"\u003cstring\u003e","reply_to_email":"\u003cstring\u003e","cc_email":"\u003cstring\u003e","bcc_email":"\u003cstring\u003e"},"send_times":[{"datetime":"\u003cdateTime\u003e","is_local":"\u003cboolean\u003e"},{"datetime":"\u003cdateTime\u003e","is_local":"\u003cboolean\u003e"}],"render_options":{"shorten_links":true,"add_org_prefix":true,"add_info_link":true,"add_opt_out_language":false},"created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"campaign":{"data":{"type":"campaign","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"template":{"data":{"type":"template","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}],"links":{"self":"\u003curi\u003e","first":"\u003curi\u003e","last":"\u003curi\u003e","prev":"\u003curi\u003e","next":"\u003curi\u003e"},"included":[{"type":"campaign","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","status":"\u003cstring\u003e","archived":"\u003cboolean\u003e","audiences":{"included":["\u003cstring\u003e","\u003cstring\u003e"],"excluded":["\u003cstring\u003e","\u003cstring\u003e"]},"send_options":{"use_smart_sending":"\u003cboolean\u003e"},"tracking_options":{"is_add_utm":"\u003cboolean\u003e","utm_params":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"is_tracking_clicks":"\u003cboolean\u003e","is_tracking_opens":"\u003cboolean\u003e"},"send_strategy":{"method":"\u003cstring\u003e","options_static":{"datetime":"\u003cdateTime\u003e","is_local":"\u003cboolean\u003e","send_past_recipients_immediately":"\u003cboolean\u003e"},"options_throttled":{"datetime":"\u003cdateTime\u003e","throttle_percentage":"\u003cinteger\u003e"},"options_sto":{"date":"\u003cdate\u003e"}},"created_at":"\u003cdateTime\u003e","scheduled_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e","send_time":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"}},{"type":"campaign","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","status":"\u003cstring\u003e","archived":"\u003cboolean\u003e","audiences":{"included":["\u003cstring\u003e","\u003cstring\u003e"],"excluded":["\u003cstring\u003e","\u003cstring\u003e"]},"send_options":{"use_smart_sending":"\u003cboolean\u003e"},"tracking_options":{"is_add_utm":"\u003cboolean\u003e","utm_params":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"is_tracking_clicks":"\u003cboolean\u003e","is_tracking_opens":"\u003cboolean\u003e"},"send_strategy":{"method":"\u003cstring\u003e","options_static":{"datetime":"\u003cdateTime\u003e","is_local":"\u003cboolean\u003e","send_past_recipients_immediately":"\u003cboolean\u003e"},"options_throttled":{"datetime":"\u003cdateTime\u003e","throttle_percentage":"\u003cinteger\u003e"},"options_sto":{"date":"\u003cdate\u003e"}},"created_at":"\u003cdateTime\u003e","scheduled_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e","send_time":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"}}]}