Advanced Search Contacts
| Scope: | search_contacts |
| App Type: | Citizen |
| Authorization Type: | Access token |
| Url: | v3/search/contacts?lang={lang}&offset={offset}&limit={limit} |
| HTTP Method: | POST |
Request Information
Parameters
application/json
{
"filter": {
"givenName": "sample string 1",
"middleNames": [
"sample string 1"
],
"familyName": "sample string 2",
"fullName": "sample string 3",
"role": "sample string 4",
"businessName": "sample string 5",
"addressLines": [
"sample string 1"
],
"zip": "sample string 6",
"city": "sample string 7",
"state": "sample string 8",
"telephoneNumbers": [
"sample string 1"
],
"faxNumber": [
"sample string 1"
],
"email": "sample string 9"
}
}
Response Information
application/json
{
"contacts": [
{
"id": "sample string 1",
"personId": "sample string 2",
"familyName": "sample string 3",
"givenName": "sample string 4",
"middleNames": [
"sample string 1"
],
"fullName": "sample string 5",
"tels": [
"sample string 1"
],
"faxs": [
"sample string 1"
],
"emails": [
"sample string 1"
],
"contactRole": {
"id": "sample string 1",
"display": "sample string 2"
},
"businessName": "sample string 6",
"isPrimary": "sample string 7",
"address": {
"display": "sample string 1",
"addressLine1": "sample string 2",
"addressLine2": "sample string 3",
"addressLine3": "sample string 4",
"state": "sample string 5",
"postalCode": "sample string 6",
"city": "sample string 7",
"country": "sample string 8",
"isPrimary": "sample string 9",
"xCoordinate": "sample string 10",
"yCoordinate": "sample string 11"
},
"licenses": [
{
"licenseType": {
"id": "sample string 1",
"display": "sample string 2"
},
"licenseNumber": "sample string 1",
"issuedDate": "sample string 2",
"expirationDate": "sample string 3",
"entityState": "sample string 4"
}
]
}
],
"page": {
"totalRows": 1,
"hasMore": true
}
}