GET api/Domain?user={user}&name={name}&contact={contact}&contactType={contactType}

Return a list of domains using filters - either name or contact must be supplied

Request Information

URI Parameters

Name	Description	Type	Additional information
user	Optional user handle - if empty logged in user will be used	string	None.
name	Optional - domain name filter	string	None.
contact	Optional - contact handle associated with domain	string	None.
contactType	Optional - contact type to be used with contact handle, defaults to R	string	None.

Body Parameters

None.

Response Information

Resource Description

A list of domains on success
Collection of errors on failure
Return codes
200 - ok
400 - bad request
401 - unauthorized
404 - not found
500 - internal server error

Collection of Domain

Name	Description	Type	Additional information
Id	Domain id	decimal number	None.
Handle	Domain handle	string	None.
Name	Domain name	string	None.
Status		string	None.
Created	Date created	date	None.
Expires	Date expires	date	None.
Renewal	Renewal date	date	None.
TldId		integer	None.
TldName	Top level domain name	string	None.
Registrar		string	None.
NameCode	Name code - only available to owner or reseller	string	None.
AuthInfo	Auth code - only available to owner or reseller	string	None.
AuthInfoExpireson	Date that authinfo expires on (eu only)	date	None.
HasAnonymousWhois	Flag to make whis anonymous	boolean	None.
AutoRenew	Has auto renew - only available to owner or reseller	boolean	None.
CurrentProductID	The id of the product currently associated to this domain (may differ from the original product)	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1.0,
    "Handle": "sample string 2",
    "Name": "sample string 3",
    "Status": "sample string 4",
    "Created": "2025-04-04T00:27:09.8780213+02:00",
    "Expires": "2025-04-04T00:27:09.8780213+02:00",
    "Renewal": "2025-04-04T00:27:09.8780213+02:00",
    "TldId": 8,
    "TldName": "sample string 9",
    "Registrar": "sample string 10",
    "NameCode": "sample string 11",
    "AuthInfo": "sample string 12",
    "AuthInfoExpireson": "2025-04-04T00:27:09.8780213+02:00",
    "HasAnonymousWhois": true,
    "AutoRenew": true,
    "CurrentProductID": 14
  },
  {
    "Id": 1.0,
    "Handle": "sample string 2",
    "Name": "sample string 3",
    "Status": "sample string 4",
    "Created": "2025-04-04T00:27:09.8780213+02:00",
    "Expires": "2025-04-04T00:27:09.8780213+02:00",
    "Renewal": "2025-04-04T00:27:09.8780213+02:00",
    "TldId": 8,
    "TldName": "sample string 9",
    "Registrar": "sample string 10",
    "NameCode": "sample string 11",
    "AuthInfo": "sample string 12",
    "AuthInfoExpireson": "2025-04-04T00:27:09.8780213+02:00",
    "HasAnonymousWhois": true,
    "AutoRenew": true,
    "CurrentProductID": 14
  }
]

application/xml, text/xml

Sample:

<ArrayOfDomain xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Domain">
  <Domain>
    <AuthInfo>sample string 12</AuthInfo>
    <AuthInfoExpireson>2025-04-04T00:27:09.8780213+02:00</AuthInfoExpireson>
    <AutoRenew>true</AutoRenew>
    <Created>2025-04-04T00:27:09.8780213+02:00</Created>
    <CurrentProductID>14</CurrentProductID>
    <Expires>2025-04-04T00:27:09.8780213+02:00</Expires>
    <Handle>sample string 2</Handle>
    <HasAnonymousWhois>true</HasAnonymousWhois>
    <Id>1</Id>
    <Name>sample string 3</Name>
    <NameCode>sample string 11</NameCode>
    <Registrar>sample string 10</Registrar>
    <Renewal>2025-04-04T00:27:09.8780213+02:00</Renewal>
    <Status>sample string 4</Status>
    <TldId>8</TldId>
    <TldName>sample string 9</TldName>
  </Domain>
  <Domain>
    <AuthInfo>sample string 12</AuthInfo>
    <AuthInfoExpireson>2025-04-04T00:27:09.8780213+02:00</AuthInfoExpireson>
    <AutoRenew>true</AutoRenew>
    <Created>2025-04-04T00:27:09.8780213+02:00</Created>
    <CurrentProductID>14</CurrentProductID>
    <Expires>2025-04-04T00:27:09.8780213+02:00</Expires>
    <Handle>sample string 2</Handle>
    <HasAnonymousWhois>true</HasAnonymousWhois>
    <Id>1</Id>
    <Name>sample string 3</Name>
    <NameCode>sample string 11</NameCode>
    <Registrar>sample string 10</Registrar>
    <Renewal>2025-04-04T00:27:09.8780213+02:00</Renewal>
    <Status>sample string 4</Status>
    <TldId>8</TldId>
    <TldName>sample string 9</TldName>
  </Domain>
</ArrayOfDomain>