Get Domains - GetMX-API

Request

Body Params multipart/form-data

token

string

required

Token generated by the management backend

Example:

page

integer

optional

Page

Example:

1

limit

integer

optional

Number of entries per page (maximum of 20).

Example:

20

group_pay_id

string

optional

Filter by group_pay_id (group_pay_id can be obtained from the GetMX backend or through the /v1/group-pay/list endpoint, with the 'id' field corresponding to 'group_pay_id').

Example:

1

domain

string

optional

Filter by domain

Example:

a.com

mark

string

optional

Filter by remarks

Example:

mark

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://domain-open-api.getmx.com/v1/domain/list' \
--form 'token="token"' \
--form 'page="1"' \
--form 'limit="20"' \
--form 'group_pay_id="1"' \
--form 'domain="a.com"' \
--form 'mark="mark"'

Responses

🟢200成功

application/json

Body

code

integer

required

msg

string

required

data

null

required

Example

{"code":200,"msg":"Success","data":{"list":[{"id":"1716386149122277228","domain":"dev.getmx.com","user_id":"1700725672171731239","status":1,"vip_status":0,"vip_expire_time":0,"domain_sub":"dev","domain_name":"getmx","domain_suffix":"com","mark":"","mx_del_tag":-1,"send_mx_status":-1,"send_dns_zone":"","forward_mx_status":-1,"receive_mx_status":-1,"dns_key_id":"","receive_sub_domain_mx_status":-1,"group_pay_id":"","vip_ip_id":"","send_vip_ip_id":"","receive_status":1,"send_status":-1,"receive_max_num_status":1,"send_max_num_status":1,"third_imap_status":1,"admin_third_imap_status":1,"third_pop_status":1,"admin_third_pop_status":1,"third_smtp_status":1,"admin_third_smtp_status":1,"admin_receive_status":0,"admin_send_status":0,"vip_admin_config":-1,"vip_ip_country":"us","api_status":-1,"ip_status":-1,"max_mail_num":2,"max_smtp_filter_num":50,"spf_status":-1,"dkim_status":-1,"spam_status":-1,"ip_backup_status":1,"mail_password_update_status":-1,"dev_status":0,"created_at":1716386149,"updated_at":0}],"total":1}}