Clerk API (unofficial showcase)
GET/email_addresses/{email_address_id}

Get an email address

Retrieves an email address and its verification and association details. Use email_address_id to identify the address to inspect.

1 parameter
email_address_idstringrequired
The unique identifier of the email address to retrieve.

5 status codes
200Returns the email address object, including its address, verification details, linked resources, reserved status, and timestamps.
idstringoptional
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:email_address
email_addressstringrequired
reservedbooleanrequired
verificationobjectrequired
linked_toarray<object>required
matches_sso_connectionbooleanoptional
Indicates whether this email address domain matches an active enterprise connection.
created_atintegerrequired
Unix timestamp of creation
updated_atintegerrequired
Unix timestamp of creation
400Returned when the request is not successful.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
401Returned when authentication is invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
403Returned when authorization is invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Returned when the email address resource is not found.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

An invalid request returns a 400, and invalid authentication returns a 401. Invalid authorization returns a 403; the email_address_id path parameter must identify an existing email address, or the request returns a 404.