beehiiv Developer Documentation

curl https://api.beehiiv.com/v2/publications/pub_00000000-0000-0000-0000-000000000000/automations/aut_00000000-0000-0000-0000-000000000000/emails \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "automation_step_id": "00000000-0000-0000-0000-000000000000",
      "subject_line": "Welcome to our newsletter!",
      "preview_text": "Here's what to expect...",
      "status": "active",
      "created_at": 1699900000,
      "first_sent_at": 1700000000,
      "last_sent_at": 1700100000,
      "stats": {
        "email": {
          "recipients": 500,
          "delivered": 490,
          "opens": 250,
          "unique_opens": 200,
          "open_rate": 40.82,
          "clicks": 100,
          "unique_clicks": 75,
          "click_rate": 37.5,
          "unsubscribes": 2,
          "spam_reports": 1
        },
        "clicks": [
          {
            "url": "https://example.com/link",
            "total_clicks": 80,
            "total_unique_clicks": 60,
            "total_click_through_rate": 30
          }
        ]
      }
    }
  ],
  "limit": 10,
  "has_more": false
}

Retrieve all emails belonging to a specific automation, including engagement statistics for each email.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

publicationIdstringRequiredformat: "^(pub_[0-9a-fA-F\-]+)$"

The prefixed ID of the publication object

automationIdstringRequiredformat: "^(aut_[0-9a-fA-F\-]+)$"

The prefixed ID of the automation object

Query parameters

limitintegerOptional

A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.

cursorstringOptional

Cursor-based pagination (recommended): Use this opaque cursor token to fetch the next page of results. Obtain it from the next_cursor field of a previous response.

pageintegerOptional

Deprecated: Use cursor instead. Pagination returns the results in pages. Limited to 100 pages maximum.

Response

datalist of objects

limitinteger

The limit placed on the results. If no limit was specified in the request, this defaults to 10.

has_moreboolean

Cursor pagination only: Indicates whether there are more results available after the current page.

next_cursorstring

Cursor pagination only: The cursor token to use for fetching the next page of results. This will be null if has_more is false.

pageinteger>=0Defaults to 1

Offset pagination only: The page number the results are from. Only present when using deprecated offset-based pagination.

total_resultsinteger

The total number of results from all pages.

total_pagesinteger

The total number of pages.

Errors

400

Bad Request Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error