Amazon WorkMail
amazonaws · Cloud
WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored. The WorkMail API is designed for the following scenarios:
Authentication
Sample Requests
Creates a paginated call to list the aliases associated with a given entity.
Hover any highlighted part to learn what it does
| X-Amz-Target | WorkMailService.ListAliases |
curl -X POST "https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListAliases?NextToken=example&MaxResults=example" \ -H "X-Amz-Target: WorkMailService.ListAliases"
import requests
params = {
"NextToken": "example",
"MaxResults": "example"
}
headers = {
"X-Amz-Target": "WorkMailService.ListAliases"
}
response = requests.post(
"https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListAliases",
params=params,
headers=headers,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListAliases');
url.searchParams.set('NextToken', 'example');
url.searchParams.set('MaxResults', 'example');
const response = await fetch(url, {
method: 'POST',
headers: {
'X-Amz-Target': 'WorkMailService.ListAliases'
},
});
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListAliases")
q := baseURL.Query()
q.Set("NextToken", "example")
q.Set("MaxResults", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("POST", targetURL, nil)
req.Header.Set("X-Amz-Target", "WorkMailService.ListAliases")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListAliases")
uri.query = URI.encode_www_form({
"NextToken" => "example",
"MaxResults" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Post.new(uri)
req["X-Amz-Target"] = "WorkMailService.ListAliases"
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListAliases?" . http_build_query([
"NextToken" => "example",
"MaxResults" => "example"
]);
$opts = ["http" => [
"method" => "POST",
"header" => implode("\r\n", [
"X-Amz-Target: WorkMailService.ListAliases"
]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));List all the AvailabilityConfiguration 's for the given WorkMail organization.
Hover any highlighted part to learn what it does
| X-Amz-Target | WorkMailService.ListAvailabilityConfigurations |
curl -X POST "https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListAvailabilityConfigurations?NextToken=example&MaxResults=example" \ -H "X-Amz-Target: WorkMailService.ListAvailabilityConfigurations"
import requests
params = {
"NextToken": "example",
"MaxResults": "example"
}
headers = {
"X-Amz-Target": "WorkMailService.ListAvailabilityConfigurations"
}
response = requests.post(
"https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListAvailabilityConfigurations",
params=params,
headers=headers,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListAvailabilityConfigurations');
url.searchParams.set('NextToken', 'example');
url.searchParams.set('MaxResults', 'example');
const response = await fetch(url, {
method: 'POST',
headers: {
'X-Amz-Target': 'WorkMailService.ListAvailabilityConfigurations'
},
});
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListAvailabilityConfigurations")
q := baseURL.Query()
q.Set("NextToken", "example")
q.Set("MaxResults", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("POST", targetURL, nil)
req.Header.Set("X-Amz-Target", "WorkMailService.ListAvailabilityConfigurations")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListAvailabilityConfigurations")
uri.query = URI.encode_www_form({
"NextToken" => "example",
"MaxResults" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Post.new(uri)
req["X-Amz-Target"] = "WorkMailService.ListAvailabilityConfigurations"
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListAvailabilityConfigurations?" . http_build_query([
"NextToken" => "example",
"MaxResults" => "example"
]);
$opts = ["http" => [
"method" => "POST",
"header" => implode("\r\n", [
"X-Amz-Target: WorkMailService.ListAvailabilityConfigurations"
]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Returns an overview of the members of a group. Users and groups can be members of a group.
Hover any highlighted part to learn what it does
| X-Amz-Target | WorkMailService.ListGroupMembers |
curl -X POST "https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListGroupMembers?NextToken=example&MaxResults=example" \ -H "X-Amz-Target: WorkMailService.ListGroupMembers"
import requests
params = {
"NextToken": "example",
"MaxResults": "example"
}
headers = {
"X-Amz-Target": "WorkMailService.ListGroupMembers"
}
response = requests.post(
"https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListGroupMembers",
params=params,
headers=headers,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListGroupMembers');
url.searchParams.set('NextToken', 'example');
url.searchParams.set('MaxResults', 'example');
const response = await fetch(url, {
method: 'POST',
headers: {
'X-Amz-Target': 'WorkMailService.ListGroupMembers'
},
});
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListGroupMembers")
q := baseURL.Query()
q.Set("NextToken", "example")
q.Set("MaxResults", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("POST", targetURL, nil)
req.Header.Set("X-Amz-Target", "WorkMailService.ListGroupMembers")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListGroupMembers")
uri.query = URI.encode_www_form({
"NextToken" => "example",
"MaxResults" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Post.new(uri)
req["X-Amz-Target"] = "WorkMailService.ListGroupMembers"
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/amazonaws.com/workmail/2017-10-01/#X-Amz-Target=WorkMailService.ListGroupMembers?" . http_build_query([
"NextToken" => "example",
"MaxResults" => "example"
]);
$opts = ["http" => [
"method" => "POST",
"header" => implode("\r\n", [
"X-Amz-Target: WorkMailService.ListGroupMembers"
]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Postman Setup Guide
- See official documentation for authentication and setup.
What can you build with Amazon WorkMail?
Amazon WorkMail is a Cloud API. Developers commonly use cloud APIs for:
- provisioning and managing cloud infrastructure
- automating deployments and container orchestration
- monitoring uptime and performance metrics
- managing storage buckets and databases
- setting up auto-scaling and load balancing
No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Amazon WorkMail is free to use, making it a low-risk choice to experiment with.
New to APIs? Read our beginner's guide · Learn about API keys · What is REST?