API Reference

Krystal Identity API

Resources & Endpoints

Get email details

Returns details about the email.

GET
https://identity.krystal.io/api/v1/emails/{email}

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

email Required

Email Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

email_not_found

No e-mail was found matching any of the criteria provided in the arguments

 404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    email: Email {
        id: String
        subject: String
        recipients: [ EmailRecipient {
            id: String
            state: String
            delivered_at: Unix Timestamp?
        } ]
    }
}