Skip to content
Authrim

List email delivery diagnostics for one end user.

GET
/api/admin/users/{id}/email-deliveries
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/users/example/email-deliveries?limit=20' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Header Parameters

Section titled “Header Parameters ”
X-Tenant-Id
string

Tenant selector for multi-tenant admin requests.

Query Parameters

Section titled “Query Parameters ”
limit
integer
default: 20 >= 1 <= 100

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Privacy-projected email delivery history.

Media type application/json
object
recipient_visibility
required
string
Allowed values: full masked none
items
required
Array<object>
<= 100 items
object
intent_id
required
string
account_id
required
string | null
notification_kind
required
string
recipient
required

Omitted, masked, or full according to recipient_visibility.

string | null
recipient_visibility
required
string
Allowed values: full masked none
api_status
required
string
Allowed values: recorded
provider_installation_id
required
string
provider_message_id
required
string | null
status
required
string
Allowed values: requested retrying provider_accepted delivered deferred bounced failed rejected complained unknown expired canceled
final_delivery_tracked
required
boolean
attempts
required
integer
last_error_code
required
string | null
requested_at
required
integer | null
provider_accepted_at
required
integer | null
status_updated_at
required
integer | null
key
additional properties
key
additional properties
Example 
{
  "recipient_visibility": "full",
  "items": [
    {
      "recipient_visibility": "full",
      "api_status": "recorded",
      "status": "requested"
    }
  ]
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}