Basic information

API requests are made at the following address:
https://quix.email/api/v1/<API_KEY>/<METHOD>

Where:
API_KEY - API access key, which you can get on the Profile page.
METHOD - API method name. The list of available methods is presented below.

The response content will be in JSON format with the following fields:

Name	Type	Description
success	bool	Whether the request was successful. If false, the error field will be present, but the result will be absent, and vice versa.
error	string	Error text.
result	mixed	Response Contents (response fields).

You can restrict access to the API with your key by IP. To do this, go to Profile, specify from which IP addresses access will be allowed, enter the password for the account and click the "Change allowed IP addresses" button.

Get account balance

Response fields

Name	Type	Description
balance	float	Your account balance in USD.

Get domains list. Returns an array

Request parameters

Name	Type	Required	Description
info	bool	false	Whether to also return information about the number and cost of mail. If true, each element of the returned array will contain the response fields described below. Otherwise (false) - each element of the returned array will contain only a string with the domain. Default - true.

Response fields

Name	Type	Description
domain	string	Email domain.
quantity	int	Available quantity.
price	float	Cost of one mail.
customUsername	bool	Whether custom usernames available for this email domain.

Request Email for an activation

Request parameters

Name	Type	Required	Description
site	string	true	The domain of the site from which the email will be sent.
domain	string	true	Email domain (see emailDomains request).
username	string	false	Customize username. Available only for our email domains (see emailDomains request).

Response fields

Name	Type	Description
id	string	Activation ID.
email	string	Email you can use.
site	string	The domain from which the email will be expected.

Get activation status and email content (if any)

Request parameters

Name	Type	Required	Description
id	string	true	Activation ID.
html	bool	false	Get content as HTML code.

Response fields

Name	Type	Description
id	string	Activation ID.
email	string	Email you can use.
status	string	Activation status, one of: - completed - cancelled - no_email.
data	string	Contents of the email. Available with completed status.

Cancel activation

Request parameters

Name	Type	Required	Description
id	string	true	Activation ID.

Response fields

Name	Type	Description
cancelled	bool	Whether the cancellation performed.

Repeat activation

Request parameters

Name	Type	Required	Description
id	string	true	Activation ID, email and domain which must be reused.

Response fields

Name	Type	Description
id	string	New activation ID.
email	string	Email you can use.
site	string	The domain from which the email will be expected.