Get an email inbox
Returns an account-scoped, non-deleted inbox. Missing and foreign inboxes are indistinguishable.
GET
/
email_inboxes
/
{id}
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const EmailInbox = await client.emailInboxes.retrieve('id');
console.log(EmailInbox.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
email_inbox = client.email_inboxes.retrieve(
"id",
)
print(email_inbox.data)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
emailInboxe, err := client.EmailInboxes.Get(
context.TODO(),
"id",
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", emailInboxe.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
var response = client.emailInboxes().retrieve("id");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
email_inbox = telnyx.email_inboxes.retrieve("id")
puts(email_inbox)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$email_inbox = $client->emailInboxes->retrieve(
'id',
);
var_dump($email_inbox);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx email-inboxes retrieve \
--api-key 'My API Key' \
--id idcurl --request GET \
--url https://api.telnyx.com/v2/email_inboxes/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "11111111-1111-1111-1111-111111111111",
"record_type": "email_inbox",
"address": "agent-1@abc123def456.mail.test.telnyx.com",
"status": "active",
"domain_id": "22222222-2222-2222-2222-222222222222",
"domain": "abc123def456.mail.test.telnyx.com",
"settings": {},
"created_at": "2026-07-12T00:00:00Z",
"updated_at": "2026-07-12T00:00:00Z"
}
}{
"errors": [
{
"code": "10006",
"title": "Not authorized",
"detail": "Invalid API key",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10006"
}
}
]
}{
"errors": [
{
"code": "10001",
"title": "Not Found",
"detail": "The requested email_inbox was not found"
}
]
}{
"errors": [
{
"code": "10016",
"title": "Service Unavailable",
"detail": "The email domain service is temporarily unavailable. Please try again later."
}
]
}Authorizations
Telnyx API key supplied as Authorization: Bearer <token>. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.
Path Parameters
Email inbox UUID.
Response
Email inbox details.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const EmailInbox = await client.emailInboxes.retrieve('id');
console.log(EmailInbox.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
email_inbox = client.email_inboxes.retrieve(
"id",
)
print(email_inbox.data)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
emailInboxe, err := client.EmailInboxes.Get(
context.TODO(),
"id",
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", emailInboxe.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
var response = client.emailInboxes().retrieve("id");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
email_inbox = telnyx.email_inboxes.retrieve("id")
puts(email_inbox)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$email_inbox = $client->emailInboxes->retrieve(
'id',
);
var_dump($email_inbox);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx email-inboxes retrieve \
--api-key 'My API Key' \
--id idcurl --request GET \
--url https://api.telnyx.com/v2/email_inboxes/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "11111111-1111-1111-1111-111111111111",
"record_type": "email_inbox",
"address": "agent-1@abc123def456.mail.test.telnyx.com",
"status": "active",
"domain_id": "22222222-2222-2222-2222-222222222222",
"domain": "abc123def456.mail.test.telnyx.com",
"settings": {},
"created_at": "2026-07-12T00:00:00Z",
"updated_at": "2026-07-12T00:00:00Z"
}
}{
"errors": [
{
"code": "10006",
"title": "Not authorized",
"detail": "Invalid API key",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10006"
}
}
]
}{
"errors": [
{
"code": "10001",
"title": "Not Found",
"detail": "The requested email_inbox was not found"
}
]
}{
"errors": [
{
"code": "10016",
"title": "Service Unavailable",
"detail": "The email domain service is temporarily unavailable. Please try again later."
}
]
}