Skip to content
Shroud.email

List email aliases

GET
/api/v1/aliases
 
curl --request GET \
  --url 'https://app.shroud.email/api/v1/aliases?page=1&page_size=20&search=Acme&enabled=false' \
  --header 'Authorization: Bearer <token>'

Lists your non-deleted email aliases, newest first. OAuth scope: aliases:read.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “ Query Parameters ”
page
integer

Page number (default 1).

Example 

1
page_size
integer

Entries per page (default 20).

Example 

20
search
string

Case-insensitive literal substring search across address, title and notes. Every whitespace-separated term must match at least one field; punctuation is matched literally.

Example 

Acme
enabled
boolean

Filter enabled or disabled aliases.

Example 

false

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Email aliases

Media type application/json
object
email_aliases
required
Array<object>
EmailAlias
object
address
required
string format: email
blocked
required
integer
blocked_addresses
required
Array<string>
enabled
required
boolean
forwarded
required
integer
notes
required
string
nullable
title
required
string
nullable
page_number
required
integer
page_size
required
integer
total_entries
required
integer
total_pages
required
integer

Example 

{
  "email_aliases": [
    {
      "address": "deadbeef@fog.shroud.email",
      "blocked": 33,
      "blocked_addresses": [
        "spammer@example.com"
      ],
      "enabled": true,
      "forwarded": 26,
      "notes": "Used for webshop newsletters etc.",
      "title": "Newsletters"
    }
  ],
  "page_number": 1,
  "page_size": 20,
  "total_entries": 1,
  "total_pages": 1
}

401

Section titled “ 401 ”

Invalid token

Media type application/json
Error
object
error
required
string

Example 

{
  "error": "Invalid token"
}

403

Section titled “ 403 ”

Insufficient scope or unconfirmed account

Media type application/json
Error
object
error
required
string

Example 

{
  "error": "Invalid token"
}

422

Section titled “ 422 ”

Invalid search or enabled filter

Media type application/json
Error
object
error
required
string

Example 

{
  "error": "Invalid search or enabled filter"
}