List newsletters

Returns a list of your newsletters and associated metadata.

get/v1/newsletters

Query parameters

limitinteger

The maximum number of results you want to retrieve per page.

sort'asc' | 'desc'

Determine how you want to sort results, asc for chronological order and desc for reverse chronological order.

startstring

The token for the page of results you want to return. Responses contain a next property. Use this property as the start value to return the next page of results.

Response

Returns an array of newsletter objects.

nextstring

Indicates the next page of results. Add ?start=<next_value> to the request to get the next page of results.

Example response

{
  "newsletters": [
    {
      "id": 128275,
      "deduplicate_id": "128275:1484870424",
      "type": "email",
      "content_ids": [
        45
      ],
      "name": "Weekly Product Update",
      "sent_at": 1481653929,
      "created": 1481653919,
      "updated": 1481653929,
      "recipient_segment_ids": [
        42,
        99
      ],
      "tags": [
        "Product Updates"
      ],
      "subscription_topic_id": 5
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.