Get account email deliverability

GET /api/v2/me/email-deliverability

Report whether email from Hostup currently reaches the account's primary email address.

status is computed server-side from the delivery log (bounces, complaints, per-recipient outcomes over the last 90 days) and the live block state at the email provider: ok (last message delivered), transient (repeated soft bounces such as a full mailbox), undeliverable (the provider rejected the address permanently), suppressed (blocked at our email provider after an earlier hard bounce — can be cleared with the send-test action), complaint (mail from us was reported as spam; change the address instead), unknown (no delivery data).

Consumers render reason and the actions gates verbatim.

Account & Access Account

Authentication

Required API scope: read:account

Authenticate with an API key in the Authorization: Bearer <token> header.

Context

Headers

Authorization Bearer <token>
Accept application/json

Responses

200 Deliverability of the account email.
email string required · Example: [email protected]
status string · enum required · Example: ok
ok
transient
undeliverable
suppressed
complaint
unknown
reason string · nullable required · Example: null

lastBounceAt string · nullable required · Example: null

lastBounceKind string · nullable · enum required · Example: null

permanent
transient
suppression
complaint
lastDeliveredAt string · nullable required · Example: 2026-08-20T14:05:24.000Z

lastTest object · nullable required · Example: null

uiShouldShow boolean required · Example: false
actions object required
actions.canSendTest object required
actions.canSendTest.allowed boolean required
actions.canSendTest.reason string · nullable required

Nullable: may be null when not applicable.

actions.canChangeEmail object required
actions.canChangeEmail.allowed boolean required
actions.canChangeEmail.reason string · nullable required

Nullable: may be null when not applicable.

400 Invalid request. The response body is an RFC 7807 Problem Details document.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
401 Authentication required (Problem Details).

No response body

403 Forbidden. The caller lacks a required scope or does not own the resource.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
404 Not found. The resource does not exist or is not owned by the caller.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
429 Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
500 Internal error. Retry later or contact support if the issue persists.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
503 The account email could not be loaded from the billing system (Problem Details, code upstream_unavailable).

No response body

GET https://cloud.hostup.se/api/v2/me/email-deliverability
For AI assistants
View as Markdown
cURL 
curl -X GET "https://cloud.hostup.se/api/v2/me/email-deliverability" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Response 
{
  "email": "[email protected]",
  "status": "ok",
  "reason": null,
  "lastBounceAt": null,
  "lastBounceKind": null,
  "lastDeliveredAt": "2026-08-20T14:05:24.000Z",
  "lastTest": null,
  "uiShouldShow": false,
  "actions": {
    "canSendTest": {
      "allowed": true,
      "reason": null
    },
    "canChangeEmail": {
      "allowed": true,
      "reason": null
    }
  }
}