API Reference
Domains
List available email domains for creating temporary accounts.
GET /domains
Get the list of available domains. You need a domain before you can create an account. Returns a paginated list of domains.
Body
None
Params
| Name | Type | Description |
|---|---|---|
| page | int | The collection page number |
Response
{
"hydra:member": [
{
"@id": "string",
"@type": "string",
"@context": "string",
"id": "string",
"domain": "string",
"isActive": true,
"isPrivate": true,
"createdAt": "2022-04-01T00:00:00.000Z",
"updatedAt": "2022-04-01T00:00:00.000Z"
}
],
"hydra:totalItems": 0,
"hydra:view": {
"@id": "string",
"@type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
},
"hydra:search": {
"@type": "string",
"hydra:template": "string",
"hydra:variableRepresentation": "string",
"hydra:mapping": [
{
"@type": "string",
"variable": "string",
"property": "string",
"required": true
}
]
}
}
When you create an email, you have to know first which domain to use.
You'll need to retrieve the domain, and then, do like so:
"user@"+domains[0]['domain']
There are up to 30 domains per page, to check the total number, retrieve it from "hydra:totalItems"
GET /domains/{id}
Retrieve a domain by its id (Useful for deleted/private domains)
Body
None
Params
| Name | Type | Description |
|---|---|---|
| id | string | The domain you want to get with id |
Response
{
"@id": "string",
"@type": "string",
"@context": "string",
"id": "string",
"domain": "string",
"isActive": true,
"isPrivate": true,
"createdAt": "2022-04-01T00:00:00.000Z",
"updatedAt": "2022-04-01T00:00:00.000Z"
}