DomainService
List domains
get/v1beta/domains
Query parameters
order_by.idstring
Domain id number.
order_by.domain_namestring
The domain name.
order_by.domain_extensionstring
Domain extension.
order_by.order_datestring
The order date.
order_by.active_datestring
The active date.
order_by.expiration_datestring
This value might align with the registry_expiration_date. It is not the primary reference for domain expiration in Openprovider.
order_by.renewal_datestring
The date and time by which a domain must be renewed to avoid expiration, please always refer to the renewal_date to process domain renewals.
order_by.statusstring
Domain status.
order_by.transfer_datestring
The transfer date.
limitinteger
The limit.
offsetinteger
The offset.
idinteger
Domain id number.
extensionstring
Domain extension.
renewal_datestring
The date and time by which a domain must be renewed to avoid expiration, please always refer to the renewal_date to process domain renewals.
full_namestring
Full name of the domain.
domain_name_patternstring
The domain name pattern.
ns_group_patternstring
Nameserver group name pattern.
statusstring
Domain status.
status_not_equalstring[]
Array of domain statuses to exclude.
queue_statusstring
The queue status.
contact_handlestring
Handle to filter by.
comment_patternstring
The comment pattern.
with_historyboolean
With history.
with_api_historyboolean
With api history.
with_additional_databoolean
With additional data.
application_modestring
When new gTLD is started it gets through several phases before it becomes available for registration to everybody (General availability or GA). There are several phases before GA when it is still possible to apply for a domain, but with some restrictions.
with_verification_emailboolean
Returns information about domain owner email verification status.
with_registry_statusesboolean
Indicates, if registry EPP statuses should be retrieved.
response.typestring
The type.
response.tostring
The to.
is_deletedboolean
Indicates whether object is deleted.
with_abuse_detailsboolean
Returns domain abuse details.
is_abusiveboolean
Returns only abusive domains.
domain_namesstring[]
Array of full domain names. Maximum of 100 names is used per request.
Response
A successful response.
Example response
{
"code": 0,
"data": {
"results": [
{
"abuse_details": {
"abuse_action": "",
"abuse_id": 0,
"abuse_status": "",
"created_at": "2022-01-01 00:00:00",
"expired_at": "2022-01-01 00:00:00",
"is_domain_held": false,
"message": "",
"suspended_at": "2022-01-01 00:00:00"
},
"active_date": "2019-01-27 0:55:17",
"additional_data": {
"abogado_acceptance": "",
"admin_sing_pass_id": "",
"ae_acceptance": "1",
"allocation_token": "",
"auth_code": "",
"bank_acceptance": "",
"company_registration_number": "XX123456789X01",
"consent_for_publishing": "",
"coop_acceptance": "1",
"customer_uin": "374892173498127349",
"customer_uin_doc_type": {
"description": "Singapore Personal Access ID",
"doc_type": "singpass"
},
"dk_acceptance": "",
"domain_name_variants": [
"xn--домен.cat"
],
"eligibility_type": "",
"eligibility_type_relationship": "",
"es_annex_acceptance": "1",
"ftld_token": "",
"gay_donation_acceptance": "1",
"gay_rights_protection_acceptance": "1",
"id_number": "123456789X",
"id_type": "",
"idn_script": "SPA",
"iisse_acceptance": "",
"insurance_acceptance": "",
"intended_use": "generic",
"it_nexus_declaration": "NO",
"it_reseller_declaration": "NO",
"law_acceptance": "",
"legal_type": "Individual",
"maintainer": "",
"membership_id": "A",
"mobile_phone_number_verification": "",
"ngo_ong_eligibility_acceptance": "",
"ngo_ong_policy_acceptance": "",
"nz_privacy_option": "public",
"passport_number": "X123456",
"rurf_blocked_domains": "",
"self_service": "1",
"trade_auth_key": "",
"trademark": "1",
"trademark_id": "",
"travel_acceptance": "1",
"ua_license": "",
"vat": "11843009X",
"verification_code": "",
"vote_acceptance": "",
"voto_acceptance": ""
},
"admin_handle": "XX123456-XX",
"api_history": [
{
"cmd": "deleteDomainRequest",
"created_at": "2018-09-05 13:58:55",
"domain_id": 12345678,
"in": "",
"out": ""
}
],
"application_id": "A743C511084404F31B15757DC979A1412-ABI",
"application_mode": "",
"application_mode_expiration_date": "",
"application_mode_title": "",
"application_notice_id": "983bdc1a0000100000188801724",
"application_smd": "",
"auth_code": "1a2b3c4d5e6f",
"autorenew": "default",
"billing_handle": "XX123456-XX",
"can_renew": false,
"comments": "",
"comments_last_changed_at": "2018-01-30 14:37:49",
"creation_date": "2013-07-04 17:14:44",
"delete_status": "quarantine",
"deleted_at": "0000-00-00 00:00:00",
"dnssec": "unsigned",
"dnssec_keys": [
{
"alg": 8,
"flags": 257,
"protocol": 3,
"pub_key": "WSgigdu8545g96",
"readonly": 1
}
],
"domain": {
"extension": "london",
"name": "test4"
},
"expiration_date": "2014-07-04 17:14:44",
"hard_quarantine_expiry_date": "",
"has_active_sectigo_zone": false,
"has_history": false,
"history": [
{
"contents": "Domain: test-example.tldAction: registration succeededStatus: ACTOrder date: 2018-01-30Activation date: 2018-01-30Renewal date: 2019-01-27Expiration date: 2019-01-29Comments: registration of this domain has succeeded Nameserver addresses are automatically resolved by system; Nameserver IP addresses are only saved for glue records",
"domain": "example.com",
"ip": "12.123.3.12",
"subject": "Sent status e-mail to admin@someemail.nl",
"timestamp": "2018-01-30T14:38:45+01:00",
"type": "I"
}
],
"id": 123456789,
"internal_auth_code": "1a2b3c4d5e6f",
"is_abusive": false,
"is_client_hold_enabled": "no",
"is_deleted": false,
"is_dnssec_enabled": false,
"is_hosted_whois": false,
"is_lockable": false,
"is_locked": false,
"is_parked": false,
"is_premium": false,
"is_private_whois_allowed": false,
"is_private_whois_enabled": false,
"is_sectigo_dns_enabled": false,
"is_spamexperts_enabled": false,
"last_changed": "2014-04-18 7:13:05",
"modify_owner_allowed": false,
"name_servers": [
{
"ip": "12.3.123.121",
"ip6": "1s23:123:123:f",
"name": "ns1.example.com",
"seq_nr": 1
}
],
"ns_group": "dns-openprovider",
"ns_template_id": 0,
"ns_template_name": "",
"nsgroup_id": 1,
"order_date": "2013-07-04 17:14:44",
"owner": {
"company_name": "Example company",
"full_name": "Test Van Person"
},
"owner_company_name": "Company Name",
"owner_handle": "XX123456-XX",
"quarantine_expiration_date": "",
"registry_expiration_date": "2020-01-29 00:00:00",
"registry_statuses": {
"client_hold": {
"is_changeable": false,
"value": 0
},
"client_transfer_prohibited": {
"is_changeable": false,
"value": 0
}
},
"renew": 2,
"renewal_date": "2022-01-01 00:00:00",
"reseller_handle": "XX123456-XX",
"reseller_id": 12345,
"restorable_until": "",
"scheduled_at": "",
"scheduled_from": "",
"soft_quarantine_expiry_date": "",
"status": "PRE",
"tech_handle": "XX123456-XX",
"trade_allowed": false,
"trade_auth_code_required": "no",
"transfer_auth_code_required": "yes",
"transfer_cancel_supported": false,
"type": "NEW",
"unit": "y",
"use_domicile": false,
"verification_email_exp_date": "0000-00-00 00:00:00",
"verification_email_name": "test@example.com",
"verification_email_status": "not verified",
"verification_email_status_description": "-",
"whois_privacy_data": {
"expiration_date": "2020-04-29 17:15:19"
}
}
],
"total": 999
},
"desc": ""
}