Get specific message

GET 
/v1/messages/:id

Get specific message

Request

Path Parameters

id stringrequired

message id

Responses

200

Success response

Response Headers

• X-Ratelimit-Limit

  integer

  Example: 100

  The maximum number of requests that you can make per period

• X-Ratelimit-Remaining

  integer

  Example: 99

  The number of requests remaining in the current rate limit window

• X-Ratelimit-Used

  integer

  Example: 1

  The number of requests you have made in the current rate limit window

• X-Ratelimit-Reset

  integer

  Example: 1723886474

  The time at which the current rate limit window resets, in UTC epoch seconds

application/json

Schema

Schema

id string

Message ID

from email

Email from

to email

Email to

cc string[]

Email CC

subject string

Email subject

body_text string

Text version of email

body_html string

HTML version of email

created_at date-time

When message was delivered

attachments

object[]

Attachments

Array [

id string

name string

size number

]

Example (from schema)

{
  "id": "a48b927e-3a24-42ff-a748-d516e5474f85",
  "from": "\"Dropbox\" <no-reply@dropbox.com>",
  "to": "85zdx208nz@crepeau12.com",
  "cc": [],
  "subject": "Confirm your registration",
  "body_text": "Your confirmation code is 5124",
  "body_html": "<p>Your confirmation code is 5124</p>",
  "created_at": "2021-07-02T11:59:29.683895008Z",
  "attachments": []
}

400

request error

application/json

Schema

Schema

error

object

type

object

Type of error encountered.

oneOf

request_error

Typically means there's a problem with the request that you made.

api_error

Typically means there's a problem with the Temp Mail API.

code string

Error code. Some common codes are not_found, invalid_api_key, rate_limited, validation_error.

detail string

meta

object

Information about this response.

request_id string

Unique ID for the request relating to this response. Provide this when contacting Temp Mail support about a specific request.

Example (from schema)

{
  "error": {
    "type": "request_error",
    "code": "not_found",
    "detail": "Message not found"
  },
  "meta": {
    "request_id": "a48b927e-3a24-42ff-a748-d516e5474f85"
  }
}

429

rate limit error

application/json

Schema

Schema

error

object

type

object

Type of error encountered.

oneOf

request_error

Typically means there's a problem with the request that you made.

code string

detail string

meta

object

Information about this response.

request_id string

Unique ID for the request relating to this response. Provide this when contacting Temp Mail support about a specific request.

Example (from schema)

{
  "error": {
    "type": "request_error",
    "code": "rate_limited",
    "detail": "You have reached your rate limit. Please try again later."
  },
  "meta": {
    "request_id": "a48b927e-3a24-42ff-a748-d516e5474f85"
  }
}

Loading...