- Home
- API reference
- API documentation (JSON/XML)
- Tasks
- Contact tasks
Contact list
Function
This task type generates a list with certain details of domain contacts. Additional details can be displayed with the <key> key in XML or query parameters in JSON.
You can find more information about list queries here.
Description
POST /contact/_search
Query parameters
The data of the following keywords can be queried with the query parameter ?keys[]=:
- address
- alias
- city
- comment
- country
- created
- domainsafe
- fax
- fname
- id
- lname
- organization
- pcode
- phone
- sip
- state
- title
- type
- updated
- verification
{
"filters": [
{
"key": "id",
"value": "23142212",
"operator": "EQUAL",
"link": "AND",
"filters": []
}
],
"view": {
"limit": 5,
"offset": 0,
"children": true,
"from": "2019-03-01T14:31:33.6306444Z",
"to": "2019-05-09T14:00:33.6306444Z"
},
"type": "DESC"
}{
"stid": "20190628-app3-dev-11544",
"status": {
"code": "S0304",
"text": "Domain contact information was inquired successfully.",
"type": "SUCCESS"
},
"object": {
"type": "Contact",
"summary": 1
},
"data": [
{
"created": "2019-05-09T10:09:25.000+0200",
"updated": "2019-06-12T10:22:00.000+0200",
"id": 23142212,
"owner": {
"context": 4,
"user": "customer"
},
"alias": "johndoe",
"type": "PERSON",
"organization": "Company",
"title": "Dr.",
"city": "example city",
"country": "US",
"state": "",
"verification": "SUCCESS",
"fname": "john",
"lname": "doe",
"address": [
"example street"
],
"pcode": "54321",
"phone": "+49-321-54321",
"fax": "+49-321-54321"
}
]
}
Task code: 0304
Uses Contact object
Keywords
The data of the following keywords can be queried with the keyword <key>:
- address
- city
- comment
- country
- domainsafe
- fax
- id
- pcode
- phone
- remarks
- state
- title
- type
- updater
- verification
<request>
<auth>
<user>customer</user>
<password>password</password>
<context>4</context>
</auth>
<task>
<code>0304</code>
<view>
<offset>0</offset>
<limit>10</limit>
<children>0</children>
</view>
<where>
<key>name</key>
<operator>like</operator>
<value>do*</value>
</where>
<key>created</key>
</task>
</request><response>
<result>
<data>
<handle>
<alias>johndoe</alias>
<created>2008-11-21 09:45:46</created>
<fname>john</fname>
<id>9910873</id>
<lname>doe</lname>
<organization>PDA</organization>
<owner>
<context>4</context>
<user>customer</user>
</owner>
<type>ORG</type>
</handle>
<handle>
<alias>maria doe</alias>
<created>2008-11-17 15:15:13</created>
<fname>maria</fname>
<id>9910825</id>
<lname>doe</lname>
<organization>
example company</organization>
<owner>
<context>4</context>
<user>customer</user>
</owner>
<type>PERSON</type>
</handle>
<summary>2</summary>
</data>
<status>
<code>S0304</code>
<text>Domain contact information was inquired successfully.</text>
<text></text>
<type>success</type>
</status>
</result>
</response>