GET
/
transactional
curl --request GET \
  --url https://api.getbrew.ai/v1/transactional \
  --header 'Authorization: Bearer <token>'
{
  "pagination": {
    "totalResults": 15,
    "returnedResults": 10,
    "perPage": 10,
    "totalPages": 2,
    "nextCursor": "brew_cursor_2024_batch_10",
    "nextPage": "https://api.getbrew.ai/v1/transactional?cursor=brew_cursor_2024_batch_10&perPage=10"
  },
  "data": [
    {
      "id": "te_welcome_email",
      "name": "Welcome email",
      "lastUpdated": "2024-12-15T10:30:00Z",
      "dataVariables": [
        "userName",
        "dashboardUrl"
      ]
    },
    {
      "id": "te_signup_confirmation",
      "name": "Sign up confirmation",
      "lastUpdated": "2024-12-18T14:45:00Z",
      "dataVariables": [
        "confirmationUrl",
        "expiryHours"
      ]
    },
    {
      "id": "te_team_invitation",
      "name": "Team invitation",
      "lastUpdated": "2024-12-20T09:15:00Z",
      "dataVariables": [
        "firstName",
        "lastName",
        "inviteLink",
        "teamName"
      ]
    },
    {
      "id": "te_password_reset",
      "name": "Password reset",
      "lastUpdated": "2024-12-22T16:20:00Z",
      "dataVariables": [
        "resetLink",
        "validHours"
      ]
    },
    {
      "id": "te_billing_receipt",
      "name": "Payment receipt",
      "lastUpdated": "2024-12-28T11:10:00Z",
      "dataVariables": [
        "amount",
        "planName",
        "receiptUrl"
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Include your Brew API key as a Bearer token in the Authorization header.

Example: Authorization: Bearer bw_api_your_key_here

Query Parameters

​
perPage
integer
default:20

Number of results per page. Useful for controlling response size and pagination.

Required range: 10 <= x <= 50
​
cursor
string

Pagination cursor from the previous response's nextCursor field. Use this to fetch the next page of results.

Response

200
application/json

Transactional emails retrieved successfully

Paginated response containing transactional emails