List domains.

Request URL

Mail API v1.0

GET /v1/domains

Request Paramters

Parameter Value Style Type Description
X-Auth-Token - header string User Token
service_id(Optional) - query UUID Service ID
offset(Optional) - query int The number of the transactions to start displaying with (Default:0)
limit(Optional) - query int The number of transactions for displaying (Default:1000)
sort_key(Optional) create_date/domain_name query string Sort Key (Default:create_date)
sort_type(Optional) asc/desc query string Sort Order (Default:asc)

Response Paramters

Parameter Value Style Type Description
domains - - list -
service_id - plain UUID Service ID
domain_id - plain UUID Domain ID
domain_name - plain string Domain Name
total_count - plain int Total Count
current_count - plain int Current Count

Request Json

This operation does not accept a request body.

Normal response codes

200 - Success

Error response codes

401 - Access Denied
404 - Not Found




curl -i -X GET \
-H "Accept: application/json" \
-H "X-Auth-Token: 39be9f8d53044388b7f2e867eba8b140" \
HTTP/1.1 200 Success
Date: Tue, 09 Dec 2014 01:46:58 GMT
Server: Apache
Content-Length: 1003
Content-Type: application/json

    "domains": [
            "service_id": "cef6c1a8-14ff-4553-a8b3-8f2fef16ba79",
            "domain_id": "08e16a49a",
            "domain_name": ""
            "service_id": "cef6c1a8-14ff-4553-a8b3-8f2fef16ba79",
            "domain_id": "6wcsf5vuzr",
            "domain_name": ""