Skip to main content
GET
Retrieve Email Address

Autorisations

Authorization
string
header
requis

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

email:read

En-têtes

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de chemin

id
string
requis

Email address ID, prefixed emaddr_.

Réponse

Email address details

account_id
string
requis

ID of the account the address belongs to, prefixed biz_.

Exemple:

"biz_xxxxxxxxxxxxxx"

address
string
requis

The full address in lowercase, such as support@example.com.

Exemple:

"marcus@shinetime.example"

created_at
string
requis

When the address was created, as an ISO 8601 timestamp.

Exemple:

"2026-01-01T12:00:00.000Z"

domain_id
string
requis

ID of the domain the address is on, prefixed dom_.

Exemple:

"whopappdomain0000001"

id
string
requis

Email address ID, prefixed emaddr_.

Exemple:

"emaddr_xxxxxxxxxxxxxx"

password
string | null
requis

The password mail apps sign in to the mailbox with over IMAP and SMTP, using the address as the username. null unless you can use the mailbox: you own it, or nobody owns it and you have email:read and email:send.

Exemple:

"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

updated_at
string
requis

When the address was last updated, as an ISO 8601 timestamp.

Exemple:

"2026-01-01T12:00:00.000Z"

user_id
string | null
requis

ID of the team member who owns the mailbox, prefixed user_. Only they can read it or send from it. null when the whole account shares it.

Exemple:

"user_xxxxxxxxxxxxxx"