List email senders

curl --request GET \
  --url https://{dsn}/api/v1/{account_id}/email-senders \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://{dsn}/api/v1/{account_id}/email-senders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{dsn}/api/v1/{account_id}/email-senders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{dsn}/api/v1/{account_id}/email-senders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{dsn}/api/v1/{account_id}/email-senders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "object": "EmailSender",
      "email": "support@example.com",
      "display_name": "Support",
      "is_primary": true,
      "verification_status": "verified"
    }
  ],
  "total_count": 1
}

{
  "status": 401,
  "type": "errors/unauthorized",
  "title": "Unauthorized",
  "detail": "missing or invalid API key"
}

{
  "status": 404,
  "type": "errors/not_found",
  "title": "Not found",
  "detail": "email email_94a0d77db739407e932c3b97fef44aac not found"
}

GET

{account_id}

email-senders

List email senders

curl --request GET \
  --url https://{dsn}/api/v1/{account_id}/email-senders \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://{dsn}/api/v1/{account_id}/email-senders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{dsn}/api/v1/{account_id}/email-senders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{dsn}/api/v1/{account_id}/email-senders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{dsn}/api/v1/{account_id}/email-senders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "object": "EmailSender",
      "email": "support@example.com",
      "display_name": "Support",
      "is_primary": true,
      "verification_status": "verified"
    }
  ],
  "total_count": 1
}

{
  "status": 401,
  "type": "errors/unauthorized",
  "title": "Unauthorized",
  "detail": "missing or invalid API key"
}

{
  "status": 404,
  "type": "errors/not_found",
  "title": "Not found",
  "detail": "email email_94a0d77db739407e932c3b97fef44aac not found"
}

Authorizations

X-API-KEY

string

header

required

Your access token, from your dashboard under API keys.

Path Parameters

account_id

string

required

The account's acc_… id.

Response

The account's senders.

data

object[]

Show child attributes

total_count

integer

Auth

Accounts

Emails

Attachments

Drafts

Folders

Contacts

Webhooks

API keys

List email senders

Authorizations

Path Parameters

Response