Skip to main content
GET
/
organization
/
channels
List all channels
curl --request GET \
  --url https://api.getfernand.com/organization/channels \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": 12345,
    "name": "Support",
    "email": "support@piedpiper.com",
    "destination": "support@piedpiper.fernand-mails.com",
    "is_valid": true
  }
]

Documentation Index

Fetch the complete documentation index at: https://developers.getfernand.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns all email channels configured for the organization. When complete=true, includes domain verification status and DNS settings for each channel, optimized to avoid duplicate domain queries.

Authorizations

​
X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Query Parameters

​
complete
boolean
default:false

Include domain verification details for each channel.

Response

200 - application/json

Channels retrieved successfully.

​
id
integer<int64>
required

Unique identifier for the channel

Example:

12345

​
name
string
required

Display name for the channel. Defaults to the local part of the email (before @) if not set.

Maximum string length: 250
Example:

"Support"

​
email
string<email>
required

Email address for this channel

Maximum string length: 250
Example:

"support@piedpiper.com"

​
destination
string<email>
required

The actual email inbox used by Fernand to receive emails. This is where you point your email redirection to.

Example:

"support@piedpiper.fernand-mails.com"

​
is_valid
boolean
required

Whether the channel's domain has been validated and is ready to send/receive emails

Example:

true