Skip to main content
GET
/
v1
/
emails
/
{emailId}
/
accessibility-audit
Accessibility audit
curl --request GET \
  --url https://brew.new/api/v1/emails/{emailId}/accessibility-audit \
  --header 'Authorization: Bearer <token>'
{
  "score": 90,
  "summary": {
    "errors": 1,
    "warnings": 0
  },
  "issues": [
    {
      "rule": "img-alt",
      "severity": "error",
      "wcag": "1.1.1",
      "message": "Image is missing an alt attribute. Add descriptive alt text, or alt=\"\" if it is purely decorative.",
      "element": "<img src=\"https://cdn.brew.new/hero.png\">"
    }
  ]
}

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Path Parameters

emailId
string
required

Design id returned by POST /v1/emails and listed by GET /v1/emails.

Required string length: 1 - 64
Example:

"eml_2SmZOWV3ZQ7W5x6g3m4p"

Response

The audit result.

score
integer
required
Required range: 0 <= x <= 100
summary
object
required
issues
object[]
required