Show available domains

GET 
/v1/domains

Show available domains.

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

domains

object[]

Array [

name string

type string

Possible values: [public, premium, custom]

]

Example (from schema)

{
  "domains": [
    {
      "name": "string",
      "type": "public"
    }
  ]
}

Example

{
  "domains": [
    {
      "name": "example.com",
      "type": "public"
    },
    {
      "name": "yourdomain.com",
      "type": "custom"
    },
    {
      "name": "premium.com",
      "type": "premium"
    }
  ]
}

400

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...