API reference›Email Account Management APIs

List Email Alias

GEThttps://bll.titan.email/partner/listEmailAlias

API to fetch information about an email account's alias on Titan Mail Cloud infra.

Query parameters

titanOrderIdnumberrequired

The unique order ID against each domain provisioned with Titan

Example: 1

emailstringrequired

Specify the email account for which the email alias needs to be fetched.

Example: sales@xyz.com

Responses

200OKapplication/json

reqIDstringrequired

Example: server.req.id

emailstring

Email account to which aliases belong to.

Example: sales@xyz.com

aliasesobject[]

Show propertiesHide properties

emailstring

email id of alias.

Example: carsales@xyz.com

displayNamestring

display name to be shown while using this alias.

Example: Car Sale

See General Errors for other errors that this API can return.

GET/partner/listEmailAlias

#include <curl/curl.h>

int main(void) {
  curl_global_init(CURL_GLOBAL_DEFAULT);
  CURL *curl = curl_easy_init();
  if (!curl) {
    curl_global_cleanup();
    return 1;
  }

  curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");
  curl_easy_setopt(curl, CURLOPT_URL, "https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com");

  struct curl_slist *headers = NULL;
  headers = curl_slist_append(headers, "Authorization: API.Key");
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);

  CURLcode res = curl_easy_perform(curl);
  curl_easy_cleanup(curl);
  curl_slist_free_all(headers);
  curl_global_cleanup();

  return (int)res;
}

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com");
request.Headers.TryAddWithoutValidation("Authorization", "API.Key");

using var response = await client.SendAsync(request);

var client = new RestClient("https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com");
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "API.Key");
var response = await client.ExecuteAsync(request);

(require '[clj-http.client :as client])

(client/get "https://bll.titan.email/partner/listEmailAlias" {:headers {:Authorization "API.Key"}
                                                              :query-params {:titanOrderId "1"
                                                                             :email "sales@xyz.com"}})

import 'package:http/http.dart' as http;

void main() async {
  final headers = <String,String>{
    'Authorization': 'API.Key',
  };

  final response = await http.get(Uri.parse('https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com'), headers: headers);
  print(response.body);
}

let httpRequestMessage = new HttpRequestMessage(
  HttpMethod("GET"),
  new Uri("https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com")
)

httpRequestMessage.Headers.Add("Authorization", "API.Key")

let client = new HttpClient()
let! result = client.SendAsync(httpRequestMessage)

package main

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

func main() {
	requestUrl := "https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com"

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

	req.Header.Add("Authorization", "API.Key")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}

GET /partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com HTTP/1.1
Host: bll.titan.email
Authorization: API.Key

GET /bll/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com HTTP/1.1
Host: api-euc1.titan.email
Authorization: API.Key

try (AsyncHttpClient client = new DefaultAsyncHttpClient()) {
  Response response = client.prepare("GET", "https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com")
    .addHeader("Authorization", "API.Key")
    .execute()
    .get();
  System.out.println(response.getResponseBody());
}

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
  .uri(java.net.URI.create("https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com"))
  .header("Authorization", "API.Key")
  .method("GET", HttpRequest.BodyPublishers.noBody())
  .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com")
  .method("GET", null)
  .addHeader("Authorization", "API.Key")
  .build();

try (Response response = client.newCall(request).execute()) {
  System.out.println(response.body().string());
}

HttpResponse<String> response = Unirest.request("GET", "https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com")
  .header("Authorization", "API.Key")
  .asString();
System.out.println(response.getBody());

fetch('https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com', {
  headers: {
    Authorization: 'API.Key'
  }
})

import axios from 'axios'

const options = {
  method: 'GET',
  url: 'https://bll.titan.email/partner/listEmailAlias',
  params: {
    titanOrderId: '1',
    email: 'sales@xyz.com'
  },
  headers: {
    Authorization: 'API.Key'
  }
}

try {
  const { data } = await axios.request(options)
  console.log(data)
} catch (error) {
  console.error(error)
}

import { ofetch } from 'ofetch'

ofetch('https://bll.titan.email/partner/listEmailAlias', {
  query: {
    titanOrderId: '1',
    email: 'sales@xyz.com'
  },
  headers: {
    Authorization: 'API.Key'
  }
})

$.ajax({
  url: "https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com",
  method: "GET",
  processData: false,
  contentType: false,
  beforeSend(xhr) {
    xhr.setRequestHeader("Authorization", "API.Key");
  },
  data: null
}).done((response) => console.log(response));

const xhr = new XMLHttpRequest();
xhr.open("GET", "https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com");
xhr.withCredentials = true;
xhr.setRequestHeader("Authorization", "API.Key");
xhr.addEventListener("load", () => console.log(xhr.responseText));
xhr.send(null);

using HTTP

response = HTTP.get(
    "https://bll.titan.email/partner/listEmailAlias",
    ["Authorization" => "API.Key"];
    query = [
        "titanOrderId" => "1",
        "email" => "sales@xyz.com"
    ]
)

println(String(response.body))

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com")
  .get()
  .addHeader("Authorization", "API.Key")
  .build()

val response = client.newCall(request).execute()

fetch('https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com', {
  headers: {
    Authorization: 'API.Key'
  }
})

import axios from 'axios'

const options = {
  method: 'GET',
  url: 'https://bll.titan.email/partner/listEmailAlias',
  params: {
    titanOrderId: '1',
    email: 'sales@xyz.com'
  },
  headers: {
    Authorization: 'API.Key'
  }
}

try {
  const { data } = await axios.request(options)
  console.log(data)
} catch (error) {
  console.error(error)
}

import { ofetch } from 'ofetch'

ofetch('https://bll.titan.email/partner/listEmailAlias', {
  query: {
    titanOrderId: '1',
    email: 'sales@xyz.com'
  },
  headers: {
    Authorization: 'API.Key'
  }
})

import { request } from 'undici'

const { statusCode, body } = await request('https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com', {
  headers: {
    Authorization: 'API.Key'
  }
})

#import <Foundation/Foundation.h>

NSDictionary *headers = @{ @"Authorization": @"API.Key" };

NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com"]
                                                      cachePolicy:NSURLRequestUseProtocolCachePolicy
                                                  timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
[request setAllHTTPHeaderFields:headers];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
  if (error) {
    NSLog(@"%@", error);
  } else {
    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
    NSLog(@"%@", httpResponse);
  }
}];
[dataTask resume];

open Lwt.Infix

let () =
  Lwt_main.run (
    let uri = Uri.of_string "https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com" in
    let headers = Cohttp.Header.of_list [
      ("Authorization", "API.Key");
    ] in
    Cohttp_lwt_unix.Client.call ~headers (Cohttp.Code.method_of_string "GET") uri
    >>= fun (_response, body) ->
    Cohttp_lwt.Body.to_string body >>= Lwt_io.printl
  )

$ch = curl_init("https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com");

curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: API.Key']);

curl_exec($ch);

curl_close($ch);

$client = new GuzzleHttp\Client();

$response = $client->request('GET', 'https://bll.titan.email/partner/listEmailAlias', [
  'headers' => [
    'Authorization' => 'API.Key'
  ],
  'query' => [
    'titanOrderId' => '1',
    'email' => 'sales@xyz.com'
  ]
]);

use Illuminate\Support\Facades\Http;

$response = Http::withHeaders([
  'Authorization' => 'API.Key'
])
  ->get('https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com');

$headers = @{
  'Authorization' = 'API.Key'
}

$response = Invoke-WebRequest -Uri 'https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com' -Method 'GET' -Headers $headers
$response

$headers = @{
  'Authorization' = 'API.Key'
}

$response = Invoke-RestMethod -Uri 'https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com' -Method 'GET' -Headers $headers
$response

import http.client

conn = http.client.HTTPSConnection("bll.titan.email")

headers = {
  "Authorization": "API.Key"
}

conn.request(
    "GET",
    "/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com",
    headers=headers,
)

response = conn.getresponse()
print(response.read().decode())

conn.close()

import http.client

conn = http.client.HTTPSConnection("api-euc1.titan.email")

headers = {
  "Authorization": "API.Key"
}

conn.request(
    "GET",
    "/bll/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com",
    headers=headers,
)

response = conn.getresponse()
print(response.read().decode())

conn.close()

requests.get(
    "https://bll.titan.email/partner/listEmailAlias",
    headers={
      "Authorization": "API.Key"
    },
    params={
      "titanOrderId": "1",
      "email": "sales@xyz.com"
    }
)

async with aiohttp.ClientSession() as session:
    await session.get(
        "https://bll.titan.email/partner/listEmailAlias",
        headers={
          "Authorization": "API.Key"
        },
        params={
          "titanOrderId": "1",
          "email": "sales@xyz.com"
        }
    )

httpx.get(
    "https://bll.titan.email/partner/listEmailAlias",
    headers={
      "Authorization": "API.Key"
    },
    params={
      "titanOrderId": "1",
      "email": "sales@xyz.com"
    }
)

async with httpx.AsyncClient() as client:
    await client.get(
        "https://bll.titan.email/partner/listEmailAlias",
        headers={
          "Authorization": "API.Key"
        },
        params={
          "titanOrderId": "1",
          "email": "sales@xyz.com"
        }
    )

library(httr2)

response <- request("https://bll.titan.email/partner/listEmailAlias") |>
  req_headers("Authorization" = "API.Key") |>
  req_url_query(
    "titanOrderId" = "1",
    "email" = "sales@xyz.com"
  ) |>
  req_perform()

resp_body_string(response)

require 'uri'
require 'net/http'

url = URI("https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'API.Key'

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

let client = reqwest::Client::new();

let request = client
    .get("https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com")
    .header("Authorization", "API.Key");

let response = request.send().await?;

curl 'https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com' \
  --header 'Authorization: API.Key'

wget --quiet \
  --method GET \
  --header 'Authorization: API.Key' \
  --output-document \
  - 'https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com'

http --ignore-stdin 'GET' 'https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com' \
  'Authorization:API.Key'

import Foundation

var request = URLRequest(url: URL(string: "https://bll.titan.email/partner/listEmailAlias?titanOrderId=1&email=sales@xyz.com")!)
request.httpMethod = "GET"
request.setValue("API.Key", forHTTPHeaderField: "Authorization")

let (data, response) = try await URLSession.shared.data(for: request)

guard let httpResponse = response as? HTTPURLResponse,
      200..<300 ~= httpResponse.statusCode else {
  throw URLError(.badServerResponse)
}

print(String(data: data, encoding: .utf8) ?? "")

Response

{
  "reqID": "server.req.id",
  "email": "sales@xyz.com",
  "aliases": [
    {
      "email": "carsales@xyz.com",
      "displayName": "Car Sale"
    }
  ]
}