Aliases

List aliases

Returns all aliases, optionally filtered by domain. Requires scope aliases:read.

get/aliases

Request

  • Base URL: https://faivelo.com/api/v1
  • URL: https://faivelo.com/api/v1/aliases
  • Auth: HTTP bearer

Query parameters

domainstring

Filter by domain name

Response

Alias list

successboolean

Example response

{
  "success": true,
  "data": [
    {
      "address": "info@yourdomain.com",
      "localPart": "info",
      "destinations": [
        "jane@yourdomain.com",
        "bob@yourdomain.com"
      ],
      "active": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.