Skip to content

Show the email change in progress

GET
/api/v1/me/email-change
curl --request GET \
--url https://api.deploybase.eu/api/v1/api/v1/me/email-change \
--header 'Authorization: <Authorization>'

The pending address, when its code expires and how many tries remain. An expired change is still returned, with expires_at in the past. Both the 200 and the 404 carry change_blocked: “managed_by_sso” when a new change would be refused because the home team’s identity provider manages the address (the same check POST makes), else null. Requires a signed-in person: API keys are refused.

OK

Media type application/json
object
data
meta
object
request_id
string
timestamp
string
trace_id
string
data
object
attempts_left
integer
change_blocked

ChangeBlocked is why a new change would be refused whatever address is chosen, or null. “managed_by_sso”: the home team’s identity provider manages the address.

string
Allowed values: managed_by_sso
expires_at
string
pending_email
string

Example

{
"data": {
"attempts_left": 5,
"change_blocked": "managed_by_sso",
"expires_at": "2026-10-03T13:00:00Z",
"pending_email": "sam@new-mailbox.eu"
}
}

Unauthorized

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
"code": "example",
"details": "example",
"error": "example",
"meta": {
"request_id": "example",
"timestamp": "example",
"trace_id": "example"
}
}

HUMAN_SESSION_REQUIRED

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
"code": "example",
"details": "example",
"error": "example",
"meta": {
"request_id": "example",
"timestamp": "example",
"trace_id": "example"
}
}

NO_EMAIL_CHANGE, with change_blocked

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string
details
object
change_blocked

ChangeBlocked is why a change would be refused whatever address is chosen, or null.

string
Allowed values: managed_by_sso

Example

{
"details": {
"change_blocked": "managed_by_sso"
}
}

Internal Server Error

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
"code": "example",
"details": "example",
"error": "example",
"meta": {
"request_id": "example",
"timestamp": "example",
"trace_id": "example"
}
}

Live 174db30c built