List received emails for an alias

GET

/v1/aliases/{alias}/messages

Inbound email parsed by the MX engine, with parsed fields and attachment links.

Authorizations

apiKey

Scoped API key. Scopes are read ⊂ write ⊂ admin. A call needing more scope than the key holds returns 403 insufficient_scope.

Type

HTTP (bearer)

Parameters

Path Parameters

alias*

Type

string

Required

Example"support"

Query Parameters

cursor

Opaque pagination cursor; pass back next_cursor from the previous page.

Type

string

Responses

A page of messages.

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"message_id": "string",

  

  

  

"from": "jane@buyer.com",

  

  

  

"subject": "string",

  

  

  

"received_at": "string",

  

  

  

"auth": "string"

  

  

}

  

],

  

"next_cursor": "string"

}

GET

/v1/aliases/{alias}/messages

Playground

Authorization

apiKey

Variables

Key

Value

alias*

cursor

Samples

Powered by VitePress OpenAPI