Sign in
Domain

List Domains

List all Domains

get/2/domains/domains

Query parameters

account_idinteger nullable

Filter domains by account ID

The account identifier

expires_afterinteger nullable

Filter domains expiring after this timestamp

expires_beforeinteger nullable

Filter domains expiring before this timestamp

order_by'expiration' | 'name' nullable

Sort results by field

Example:expiration
order_dir'asc' | 'desc' nullable

Sort direction

Example:asc
resale_status'"authorized"' | '"listed"' | '"not_authorized"' | '"sold"' nullable

Filter domains by resale status

searchstring nullable

Filter domains by name

Example:mydomain.ch
tldstring nullable

Filter domains by TLD

Example:ch
return'total'

Optional : If you pass this parameter with the value total, then the response will be the number of items in the collection, instead of the items themselves.<br /> Part of the total capacity

pageinteger

Optional parameter that define the page number<br /> Part of the pagination capacity

per_pageinteger

Optional parameter that define the number of items per page<br /> Part of the pagination capacity

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

totalinteger

Total number of items Added when using query parameter page

pageinteger

Number of the current page Added when using query parameter page

pagesinteger

Total number of pages Added when using query parameter page

items_per_pageinteger

Number of items per page Added when using query parameter page

Example response

{
  "result": "success",
  "data": [
    {
      "id": 12345,
      "name": "mydomain.ch",
      "tld": "ch",
      "resale_status": "not_authorized",
      "created_at": 1702908000,
      "expires_at": 1734444000,
      "contacts": {
        "owner": {
          "address_type": "loc",
          "first_name": "John",
          "last_name": "Doe",
          "company": "Infomaniak",
          "street1": "Rue Eugène Marziano 25",
          "street2": "Batiment 43",
          "street3": "Etage 3",
          "postal_code": "1227",
          "city": "Les Acacias",
          "state": "Genève",
          "country_code": "CH",
          "id": 12345,
          "type": "Organization",
          "phone": "+41.223456789",
          "fax": "+41.223456790",
          "email": "contact@mydomain.ch",
          "validated_at": 1702908000,
          "created_at": 1702908000,
          "pending_modification": {
            "created_at": 1702908000,
            "associated_domains": [
              {
                "id": 1,
                "name": "mydomain.ch"
              }
            ],
            "associated_domains_count": 5000
          },
          "associated_domains": [
            {
              "id": 1,
              "name": "mydomain.ch"
            }
          ],
          "associated_domains_count": 5000
        },
        "admin": {
          "address_type": "loc",
          "first_name": "John",
          "last_name": "Doe",
          "company": "Infomaniak",
          "street1": "Rue Eugène Marziano 25",
          "street2": "Batiment 43",
          "street3": "Etage 3",
          "postal_code": "1227",
          "city": "Les Acacias",
          "state": "Genève",
          "country_code": "CH",
          "id": 12345,
          "type": "Organization",
          "phone": "+41.223456789",
          "fax": "+41.223456790",
          "email": "contact@mydomain.ch",
          "validated_at": 1702908000,
          "created_at": 1702908000,
          "pending_modification": {
            "created_at": 1702908000,
            "associated_domains": [
              {
                "id": 1,
                "name": "mydomain.ch"
              }
            ],
            "associated_domains_count": 5000
          },
          "associated_domains": [
            {
              "id": 1,
              "name": "mydomain.ch"
            }
          ],
          "associated_domains_count": 5000
        },
        "tech": {
          "address_type": "loc",
          "first_name": "John",
          "last_name": "Doe",
          "company": "Infomaniak",
          "street1": "Rue Eugène Marziano 25",
          "street2": "Batiment 43",
          "street3": "Etage 3",
          "postal_code": "1227",
          "city": "Les Acacias",
          "state": "Genève",
          "country_code": "CH",
          "id": 12345,
          "type": "Organization",
          "phone": "+41.223456789",
          "fax": "+41.223456790",
          "email": "contact@mydomain.ch",
          "validated_at": 1702908000,
          "created_at": 1702908000,
          "pending_modification": {
            "created_at": 1702908000,
            "associated_domains": [
              {
                "id": 1,
                "name": "mydomain.ch"
              }
            ],
            "associated_domains_count": 5000
          },
          "associated_domains": [
            {
              "id": 1,
              "name": "mydomain.ch"
            }
          ],
          "associated_domains_count": 5000
        },
        "billing": {
          "address_type": "loc",
          "first_name": "John",
          "last_name": "Doe",
          "company": "Infomaniak",
          "street1": "Rue Eugène Marziano 25",
          "street2": "Batiment 43",
          "street3": "Etage 3",
          "postal_code": "1227",
          "city": "Les Acacias",
          "state": "Genève",
          "country_code": "CH",
          "id": 12345,
          "type": "Organization",
          "phone": "+41.223456789",
          "fax": "+41.223456790",
          "email": "contact@mydomain.ch",
          "validated_at": 1702908000,
          "created_at": 1702908000,
          "pending_modification": {
            "created_at": 1702908000,
            "associated_domains": [
              {
                "id": 1,
                "name": "mydomain.ch"
              }
            ],
            "associated_domains_count": 5000
          },
          "associated_domains": [
            {
              "id": 1,
              "name": "mydomain.ch"
            }
          ],
          "associated_domains_count": 5000
        }
      }
    }
  ],
  "total": 221,
  "page": 2,
  "pages": 15,
  "items_per_page": 15
}

Changes