How can we help?
{{docApp.searchError}}
{{product.name}}
Searching in {{docApp.searchFilterBySpecificBookTitle}}
{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Operation Information
- Application Reference:
com.hornbill.core - Scope:
Entity - Contact - Class:
Entity - Required Privilege Level:
none - Required Rights: none
Description
For internal use only - Get a list of contacts
Request Parameters
The getList API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.
| Name | Type | Required | Description |
|---|---|---|---|
filter |
xs:string |
No | Text filter |
isArchived |
xs:boolean |
No | True for returning archived contacts only |
rowstart |
xs:integer |
No | rowstart for paging |
limit |
xs:integer |
No | Maximum to be returned |
orderByField |
xs:string |
No | Order |
orderByWay |
xs:string |
No | Ascending/Descending |
advancedSearch |
xs:string |
No | JSON representation of the advanced search data |
orgId |
xs:string |
No | Comma separated list of organisations to filter |
Response Parameters
| Name | Type | Description |
|---|---|---|
contacts |
xs:string |
Contacts object (JSON) |
count |
xs:integer |
Count of contacts |
userSetting |
xs:string |
Layout for contactlist UI |
Code Examples
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.core/Contact' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.core/Contact","@method":"getList","params":{"filter":"xs:string","isArchived":false,"rowstart":1,"limit":1,"orderByField":"xs:string","orderByWay":"xs:string","advancedSearch":"xs:string","orgId":"xs:string"}}'
package main
import (
"fmt"
apiLib "github.com/hornbill/goApiLib"
)
func main() {
hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
hornbillAPI.SetAPIKey("yourHornbillAPIKey")
hornbillAPI.SetJSONResponse(true)
hornbillAPI.SetParam("filter", "xs:string")
hornbillAPI.SetParam("isArchived", "xs:boolean")
hornbillAPI.SetParam("rowstart", "xs:integer")
hornbillAPI.SetParam("limit", "xs:integer")
hornbillAPI.SetParam("orderByField", "xs:string")
hornbillAPI.SetParam("orderByWay", "xs:string")
hornbillAPI.SetParam("advancedSearch", "xs:string")
hornbillAPI.SetParam("orgId", "xs:string")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.core/Contact", "getList")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.core/Contact";
const payload = {
"@service": "apps/com.hornbill.core/Contact",
"@method": "getList",
"params": {
"filter": "xs:string",
"isArchived": false,
"rowstart": 1,
"limit": 1,
"orderByField": "xs:string",
"orderByWay": "xs:string",
"advancedSearch": "xs:string",
"orgId": "xs:string"
}
};
fetch(endpoint, {
method: 'POST',
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
},
body: JSON.stringify(payload)
}).then(res => res.json())
.then(res => console.log(res));
const axios = require('axios');
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.core/Contact";
const payload = {
"@service": "apps/com.hornbill.core/Contact",
"@method": "getList",
"params": {
"filter": "xs:string",
"isArchived": false,
"rowstart": 1,
"limit": 1,
"orderByField": "xs:string",
"orderByWay": "xs:string",
"advancedSearch": "xs:string",
"orgId": "xs:string"
}
};
const axiosConfig = {
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
};
axios.post(endpoint, payload, axiosConfig)
.then((res) => {
console.log("RESPONSE RECEIVED: ", res);
})
.catch((err) => {
console.log("AXIOS ERROR: ", err);
})
$endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.core/Contact";
$payload = (object) [
'@service' => 'apps/com.hornbill.core/Contact',
'@method' => 'getList',
'params' => (object) [
'filter' => 'xs:string',
'isArchived' => 'xs:boolean',
'rowstart' => 'xs:integer',
'limit' => 'xs:integer',
'orderByField' => 'xs:string',
'orderByWay' => 'xs:string',
'advancedSearch' => 'xs:string',
'orgId' => 'xs:string',
]
];
$headers = [
'Authorization: ESP-APIKEY yourHornbillAPIKey',
'Content-Type: application/json'
];
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $endpoint);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$resp = curl_exec($curl);
curl_close($curl);
echo $resp;
$Endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.core/Contact"
$Body = @{
"@service" = "apps/com.hornbill.core/Contact"
"@method" = "getList"
params = @{
filter = "xs:string"
isArchived = "xs:boolean"
rowstart = "xs:integer"
limit = "xs:integer"
orderByField = "xs:string"
orderByWay = "xs:string"
advancedSearch = "xs:string"
orgId = "xs:string"
}
}
$Header = @{
"Authorization" = "ESP-APIKEY yourHornbillAPIKey"
}
$Parameters = @{
Method = "POST"
Uri = $Endpoint
Headers = $Header
Body = ($Body | ConvertTo-Json)
ContentType = "application/json"
}
Invoke-RestMethod @Parameters
import requests
import json
endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.core/Contact"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.core/Contact",
"@method":"getList",
"params":{
"filter":"xs:string",
"isArchived":"xs:boolean",
"rowstart":"xs:integer",
"limit":"xs:integer",
"orderByField":"xs:string",
"orderByWay":"xs:string",
"advancedSearch":"xs:string",
"orgId":"xs:string",
},
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document