Skip to content

List inbound-email aliases

GET
/v1/aliases

The org's inbound-email addresses. A PLATFORM alias is <label>.<org-slug>@<platform-domain> (on the shared MX, namespaced by the org slug exactly like a platform webhook URL); a CUSTOM alias is <local>@<host> (or a *@<host> catch-all) on one of the org's MX-verified email domains.

Authorizations

apiKey

Scoped API key. Scopes are readwriteadmin. A call needing more scope than the key holds returns 403 insufficient_scope.

Type
HTTP (bearer)

Parameters

Query Parameters

cursor

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

Type
string
limit
Type
integer
Maximum
100
Default
50

Responses

A page of aliases.

application/json
JSON
{
  
"data": [
  
  
{
  
  
  
"id": "al_01JX9",
  
  
  
"address": "orders.acme@emhk.in",
  
  
  
"kind": "platform",
  
  
  
"localPart": "orders",
  
  
  
"domain": "emhk.in",
  
  
  
"destinationIds": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"allowedSenders": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"maxSizeBytes": 26214400,
  
  
  
"createdAt": "string"
  
  
}
  
],
  
"next_cursor": "string"
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

Emithook · a Finnoto product