Search Contacts

Finds the contacts that match the search criteria. Similar to Automation, the Soundex search functionality is available on the street name and common contact fields, such as the following request fields: firstName, middleName, lastName, organizationName, tradeName, businessName, streetName.

Resource Information

Scope	contacts Deprecated scope name: search_contacts
App Type	All
Authorization Type	Access token
URI	/v4/search/contacts?offset={offset}&limit={limit}&fields={fields}&lang={lang}
HTTP Method	POST
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
fields	string	No	�	Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.	7.3.2
lang	String	No	�	Indicates the language applied.	7.3.2
limit	long	No	�	Indicates the number of items that are returned in each page.	7.3.2
offset	long	No	�	Indicates the offset start of each page by the number specified.	7.3.2
activity	activity{}	No	�	Action or event related to a record.	7.3.2
activity.attributeValue	string	No	�	The value of an activity attribute.	7.3.2
activity.description	string	No	�	The description of the record or item.	7.3.2
activity.name	string	No	�	The full name for the application contact.	7.3.2
activity.type	string	No	�	The activity type.	7.3.2
address	address{}	No	�	The address of the subject.	7.3.2
address.addressLine1	string	No	�	The first line of the address.	7.3.2
address.addressLine2	string	No	�	The second line of the address.	7.3.2
address.addressLine3	string	No	�	The third line of the address.	7.3.2
address.city	string	No	�	The name of the city.	7.3.2
address.country	address.country{}	No	Get All Address Countries	The name of the country.	7.3.2
address.country.text	string	No	�	The localized display text.	7.3.2
address.country.value	string	No	�	The value for the specified parameter.	7.3.2
address.postalCode	string	No	�	The postal ZIP code for the address.	7.3.2
address.state	address.state{}	No	Get All Address States	The state corresponding to the address on record.	7.3.2
address.state.text	string	No	�	The localized display text.	7.3.2
address.state.value	string	No	�	The value for the specified parameter.	7.3.2
birthCity	birthCity{}	No	�	The city of birth for an individual.	7.3.2
birthCity.text	string	No	�	The localized display text.	7.3.2
birthCity.value	string	No	�	The value for the specified parameter.	7.3.2
birthDateFrom	dateTime	No	�	The start of a birth date range to search.	7.3.2
birthDateTo	dateTime	No	�	The end of a birth date range to search.	7.3.2
birthRegion	birthRegion{}	No	�	The country of birth or region of birth for an individual.	7.3.2
birthRegion.text	string	No	�	The localized display text.	7.3.2
birthRegion.value	string	No	�	The value for the specified parameter.	7.3.2
birthState	birthState{}	No	Get All Address States	The state of birth for an individual.	7.3.2
birthState.text	string	No	�	The localized display text.	7.3.2
birthState.value	string	No	�	The value for the specified parameter.	7.3.2
businessName	string	No	�	A secondary business name for the applicable individual.	7.3.2
contactAddress	contactAddress{}	No	�	The address of the contact.	7.3.2
contactAddress.addressLine1	string	No	�	The first line of the address.	7.3.2
contactAddress.addressLine2	string	No	�	The second line of the address.	7.3.2
contactAddress.addressLine3	string	No	�	The third line of the address.	7.3.2
contactAddress.city	string	No	�	The name of the city.	7.3.2
contactAddress.country	contactAddress.country{}	No	Get All Address Countries	The name of the country.	7.3.2
contactAddress.country.text	string	No	�	The localized display text.	7.3.2
contactAddress.country.value	string	No	�	The value for the specified parameter.	7.3.2
contactAddress.direction	contactAddress.direction{}	No	Get All Address Street Directions	The street direction of the primary address associated with the application.	7.3.2
contactAddress.direction.text	string	No	�	The localized display text.	7.3.2
contactAddress.direction.value	string	No	�	The value for the specified parameter.	7.3.2
contactAddress.fax	string	No	�	The fax number for the contact.	7.3.2
contactAddress.faxCountryCode	string	No	�	Fax Number Country Code	7.3.2
contactAddress.houseAlphaEnd	string	No	�	The ending street number that makes up the address.	7.3.2
contactAddress.houseAlphaStart	string	No	�	The beginning street number that makes up the address.	7.3.2
contactAddress.id	long	No	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
contactAddress.levelEnd	string	No	�	The ending level number (floor number) that makes up the address within a complex.	7.3.2
contactAddress.levelPrefix	string	No	�	The prefix for the level numbers (floor numbers) that make up the address.	7.3.2
contactAddress.levelStart	string	No	�	The beginning level number (floor number) that makes up the address within a complex.	7.3.2
contactAddress.phone	string	No	�	The telephone number of the user.	7.3.2
contactAddress.phoneCountryCode	string	No	�	The country code for the assoicated phone number.	7.3.2
contactAddress.postalCode	string	No	�	The postal ZIP code for the address.	7.3.2
contactAddress.recipient	string	No	�	The contact person for the contact address.	7.3.2
contactAddress.state	contactAddress.state{}	No	Get All Address States	The state corresponding to the address on record.	7.3.2
contactAddress.state.text	string	No	�	The localized display text.	7.3.2
contactAddress.state.value	string	No	�	The value for the specified parameter.	7.3.2
contactAddress.status	contactAddress.status{}	No	A \| I	The address status indicating whether the address is active or inactive.	7.3.2
contactAddress.status.text	string	No	�	The localized display text.	7.3.2
contactAddress.status.value	string	No	�	The value for the specified parameter.	7.3.2
contactAddress.streetAddress	string	No	�	The street address.	7.3.2
contactAddress.streetEnd	long	No	�	The end of a range of street numbers.	7.3.2
contactAddress.streetName	string	No	�	The street name for the address.	7.3.2
contactAddress.streetPrefix	string	No	�	Any part of an address that appears before a street name or number. For example, if the address is 123 West Main, "West" is the street prefix.	7.3.2
contactAddress.streetStart	long	No	�	The start of a range of street numbers.	7.3.2
contactAddress.streetSuffix	contactAddress.streetSuffix{}	No	Get All Address Street Suffixes	The type of street such as "Lane" or "Boulevard".	7.3.2
contactAddress.streetSuffix.text	string	No	�	The localized display text.	7.3.2
contactAddress.streetSuffix.value	string	No	�	The value for the specified parameter.	7.3.2
contactAddress.streetSuffixDirection	contactAddress.streetSuffixDirection{}	No	Get All Address Street Directions	The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW" is the street suffix direction.	7.3.2
contactAddress.streetSuffixDirection.text	string	No	�	The localized display text.	7.3.2
contactAddress.streetSuffixDirection.value	string	No	�	The value for the specified parameter.	7.3.2
contactAddress.type	contactAddress.type{}	No	Get All Address Unit Types	The address type.	7.3.2
contactAddress.type.text	string	No	�	The localized display text.	7.3.2
contactAddress.type.value	string	No	�	The value for the specified parameter.	7.3.2
contactAddress.unitEnd	string	No	�	The end parameter of a range of unit numbers.	7.3.2
contactAddress.unitStart	string	No	�	The starting parameter of a range of unit numbers.	7.3.2
contactAddress.unitType	contactAddress.unitType{}	No	Get All Address Unit Types	The unit type designation of the address.	7.3.2
contactAddress.unitType.text	string	No	�	The localized display text.	7.3.2
contactAddress.unitType.value	string	No	�	The value for the specified parameter.	7.3.2
deceasedDateFrom	dateTime	No	�	The start of a deceased date range to search.	7.3.2
deceasedDateTo	dateTime	No	�	The end of a deceased date range to search.	7.3.2
driverLicenseNumber	string	No	�	The driver's license number of the contact. This field is active only when the Contact Type selected is Individual.	7.3.2
driverLicenseState	driverLicenseState{}	No	Get All Address States	The state that issued the driver's license.	7.3.2
driverLicenseState.text	string	No	�	The localized display text.	7.3.2
driverLicenseState.value	string	No	�	The value for the specified parameter.	7.3.2
email	string	No	�	The contact's email address.	7.3.2
fax	string	No	�	The fax number for the contact.	7.3.2
faxCountryCode	string	No	�	Fax Number Country Code	7.3.2
federalEmployerId	string	No	�	The Federal Employer Identification Number. It is used to identify a business for tax purposes.	7.3.2
firstName	string	No	�	The contact's first name. This field is only active when the Contact Type selected is Individual.	7.3.2
fullName	string	No	�	The contact's full name. This field is only active when the Contact Type selected is Individual.	7.3.2
gender	gender{}	No	�	The gender (male or female) of the individual.	7.3.2
gender.text	string	No	�	The localized display text.	7.3.2
gender.value	string	No	�	The value for the specified parameter.	7.3.2
id	string	No	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
individualOrOrganization	string	No	�	The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.	7.3.2
lastName	string	No	�	The last name (surname).	7.3.2
middleName	string	No	�	The middle name.	7.3.2
openCloseMatch	string	No	�	Indicates whether or not to use close matches as hits in a search for contacts.	7.3.2
openSoundexSearch	string	No	Y \| N	Indicates whether or not Soundex search is enabled for any of the following requested parameters: firstName, middleName, lastName, organizationName, tradeName, businessName, streetName	7.3.3.4
orderBy	string	No	LastName ASC, LastName DESC, FirstName ASC, FirstName DESC, birthDate ASC, birthDate DESC, AddressCity ASC, AddressCity DESC, AddressState ASC, AddressState DESC, AddressZIP ASC, AddressZIP DESC, AddressCountry ASC, AddressCountry DESC, email ASC, email DESC, PHONE1 ASC, PHONE1 DESC, PHONE2 ASC, PHONE2 DESC	The fields by which the search results are ordered. For each field, specify the sort order: asc for ascending or desc for descending order. Use commas to separate multiple sort fields. The values are not case-sensitive. For example: "orderBy":"lastName desc,email asc"	7.3.3.5
organizationName	string	No	�	The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.	7.3.2
passportNumber	string	No	�	The contact's passport number. This field is only active when the Contact Type selected is Individual.	7.3.2
phone1	string	No	�	The primary telephone number of the contact.	7.3.2
phone1CountryCode	string	No	�	Phone Number 1 Country Code	7.3.2
phone2	string	No	�	The secondary telephone number of the contact.	7.3.2
phone2CountryCode	string	No	�	Phone Number 2 Country Code	7.3.2
phone3	string	No	�	The tertiary telephone number for the contact.	7.3.2
phone3CountryCode	string	No	�	Phone Number 3 Country Code	7.3.2
postOfficeBox	string	No	�	The post office box number.	7.3.2
preferredChannel	preferredChannel{}	No	Get All Contact Preferred Channels	The method by which the contact prefers to be notified, by phone for example.	7.3.2
preferredChannel.text	string	No	�	The localized display text.	7.3.2
preferredChannel.value	string	No	�	The value for the specified parameter.	7.3.2
race	race{}	No	Get All Contact Races	The contact's race or ethnicity.	7.3.2
race.text	string	No	�	The localized display text.	7.3.2
race.value	string	No	�	The value for the specified parameter.	7.3.2
relation	relation{}	No	�	The contact's relationship to the application or service request.	7.3.2
relation.text	string	No	�	The localized display text.	7.3.2
relation.value	string	No	�	The value for the specified parameter.	7.3.2
salutation	salutation{}	No	Get All Contact Salutations	The salutation to be used when addressing the contact; for example Mr. or Ms. This field is active only when Contact Type = Individual.	7.3.2
salutation.text	string	No	�	The localized display text.	7.3.2
salutation.value	string	No	�	The value for the specified parameter.	7.3.2
serviceProviderCode	string	No	�	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
socialSecurityNumber	string	No	�	The individual's social security number. This field is only active when the Contact Type selected is Individual.	7.3.2
stateIdNumber	string	No	�	The contact's state ID number. This field is only active when the Contact Type selected is Individual.	7.3.2
status	status{}	No	�	The contact status.	7.3.2
status.text	string	No	�	The localized display text.	7.3.2
status.value	string	No	�	The value for the specified parameter.	7.3.2
suffix	string	No	�	The contact name suffix.	7.3.2
title	string	No	�	The individual's business title.	7.3.2
tradeName	string	No	�	The contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization.	7.3.2
type	type{}	No	�	The people type.	7.3.2
type.text	string	No	�	The localized display text.	7.3.2
type.value	string	No	�	The value for the specified parameter.	7.3.2

Example

Sample Request Body

The following sample shows a Soundex search request which searches contacts whose first and last name sounds like the given values:
{
  "openSoundexSearch" : "Y",
  "firstName":"Lisa",
  "lastName":"Johnson"
}

Response Information

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.2
result.additionalAddresses[]	result.additionalAddresses{}	Additional address information.	7.3.2
result.address	result.address{}	The citizen user's address.	7.3.2
result.address.addressLine1	string	The first line of the address.	7.3.2
result.address.addressLine2	string	The second line of the address.	7.3.2
result.address.addressLine3	string	The third line of the address.	7.3.2
result.address.city	string	The name of the city.	7.3.2
result.address.country	result.address.country{}	The name of the country.	7.3.2
result.address.country.text	string	The localized display text.	7.3.2
result.address.country.value	string	The value for the specified parameter.	7.3.2
result.address.postalCode	string	The postal ZIP code for the address.	7.3.2
result.address.state	result.address.state{}	The state corresponding to the address on record.	7.3.2
result.address.state.text	string	The localized display text.	7.3.2
result.address.state.value	string	The value for the specified parameter.	7.3.2
result.birthCity	result.birthCity{}	The city of birth for an individual.	7.3.2
result.birthCity.text	string	The localized display text.	7.3.2
result.birthCity.value	string	The value for the specified parameter.	7.3.2
result.birthDate	dateTime	The birth date of an individual.	7.3.2
result.birthRegion	result.birthRegion{}	The country of birth or region of birth for an individual.	7.3.2
result.birthRegion.text	string	The localized display text.	7.3.2
result.birthRegion.value	string	The value for the specified parameter.	7.3.2
result.birthState	result.birthState{}	The state of birth for an individual.	7.3.2
result.birthState.text	string	The localized display text.	7.3.2
result.birthState.value	string	The value for the specified parameter.	7.3.2
result.businessName	string	A secondary business name for the applicable individual.	7.3.2
result.comment	string	Comments or notes about the current context.	7.3.2
result.deceasedDate	dateTime	The date of death. This field is active only when the Contact Type selected is Individual.	7.3.2
result.driverLicenseNumber	string	The driver's license number of the contact. This field is active only when the Contact Type selected is Individual.	7.3.2
result.driverLicenseState	result.driverLicenseState{}	The state that issued the driver's license.	7.3.2
result.driverLicenseState.text	string	The localized display text.	7.3.2
result.driverLicenseState.value	string	The value for the specified parameter.	7.3.2
result.email	string	The contact's email address.	7.3.2
result.fax	string	The fax number for the contact.	7.3.2
result.faxCountryCode	string	Fax Number Country Code	7.3.2
result.federalEmployerId	string	The Federal Employer Identification Number. It is used to identify a business for tax purposes.	7.3.2
result.firstName	string	The contact's first name. This field is only active when the Contact Type selected is Individual.	7.3.2
result.fullName	string	The contact's full name. This field is only active when the Contact Type selected is Individual.	7.3.2
result.gender	result.gender{}	The gender (male or female) of the individual.	7.3.2
result.gender.text	string	The localized display text.	7.3.2
result.gender.value	string	The value for the specified parameter.	7.3.2
result.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.individualOrOrganization	string	The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.	7.3.2
result.lastName	string	The last name (surname).	7.3.2
result.middleName	string	The middle name.	7.3.2
result.organizationName	string	The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.	7.3.2
result.passportNumber	string	The contact's passport number. This field is only active when the Contact Type selected is Individual.	7.3.2
result.phone1	string	The primary telephone number of the contact.	7.3.2
result.phone1CountryCode	string	Phone Number 1 Country Code	7.3.2
result.phone2	string	The secondary telephone number of the contact.	7.3.2
result.phone2CountryCode	string	Phone Number 2 Country Code	7.3.2
result.phone3	string	The tertiary telephone number for the contact.	7.3.2
result.phone3CountryCode	string	Phone Number 3 Country Code	7.3.2
result.postOfficeBox	string	The post office box number.	7.3.2
result.preferredChannel	result.preferredChannel{}	The method by which the contact prefers to be notified, by phone for example.	7.3.2
result.preferredChannel.text	string	The localized display text.	7.3.2
result.preferredChannel.value	string	The value for the specified parameter.	7.3.2
result.race	result.race{}	The contact's race/ethnicity.	7.3.2
result.race.text	string	The localized display text.	7.3.2
result.race.value	string	The value for the specified parameter.	7.3.2
result.relation	result.relation{}	The contact's relationship to the application or service request.	7.3.2
result.relation.text	string	The localized display text.	7.3.2
result.relation.value	string	The value for the specified parameter.	7.3.2
result.salutation	result.salutation{}	The salutation to be used when addressing the contact; for example Mr. or Ms. This field is active only when Contact Type = Individual.	7.3.2
result.salutation.text	string	The localized display text.	7.3.2
result.salutation.value	string	The value for the specified parameter.	7.3.2
result.serviceProviderCode	string	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
result.socialSecurityNumber	string	The individual's social security number. This field is only active when the Contact Type selected is Individual.	7.3.2
result.stateIdNumber	string	The contact's state ID number. This field is only active when the Contact Type selected is Individual.	7.3.2
result.status	result.status{}	The contact status.	7.3.2
result.status.text	string	The localized display text.	7.3.2
result.status.value	string	The value for the specified parameter.	7.3.2
result.suffix	string	The contact name suffix.	7.3.2
result.title	string	The individual's business title.	7.3.2
result.tradeName	string	The contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization.	7.3.2
result.type	result.type{}	The type of people to contact.	7.3.2
result.type.text	string	The localized display text.	7.3.2
result.type.value	string	The value for the specified parameter.	7.3.2
status	integer	The record status.	7.3.3

Example

Sample Response Body

{
  "result": [
    {
      "serviceProviderCode": "BPTDEV",
      "individualOrOrganization": "individual",
      "driverLicenseNumber": "A1234567",
      "id": "370",
      "email": "devin.yao@beyondsoft.com",
      "fax": "7654321",
      "phone1": "18051234567",
      "middleName": "M.",
      "firstName": "Lisa",
      "lastName": "Johnson",
      "type": {
        "value": "Individual",
        "text": "Individual"
      },
      "preferredChannel": {
        "value": "1",
        "text": "Email"
      },
      "status": {
        "value": "A",
        "text": "Active"
      },
      "address": {
        "addressLine1": "123 Main Street",
        "addressLine2": "Coast Village RV Park",
        "city": "Pismo Beach",
        "postalCode": "93448",
        "state": {
          "value": "CA",
          "text": "California"
        }
      }
    },
    {
      "serviceProviderCode": "BPTDEV",
      "individualOrOrganization": "individual",
      "driverLicenseNumber": "C1234567",
      "id": "424",
      "phone1": "12345678",
      "firstName": "Liza",
      "lastName": "Johnston",
      "type": {
        "value": "Individual",
        "text": "Individual"
      },
      "preferredChannel": {
        "value": "1",
        "text": "Email"
      },
      "status": {
        "value": "A",
        "text": "Active"
      },
      "address": {}
    }
  ],
  "status": 200,
  "page": {
    "offset": 0,
    "total": 2,
    "limit": 1000,
    "hasmore": false
  }
}