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

Scopecontacts

Deprecated scope name:   search_contacts

App TypeAll
Authorization TypeAccess token
URI /v4/search/contacts?offset={offset}&limit={limit}&fields={fields}&lang={lang}
HTTP MethodPOST
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringNo 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
langStringNo Indicates the language applied.7.3.2
limitlongNo Indicates the number of items that are returned in each page.7.3.2
offsetlongNo Indicates the offset start of each page by the number specified.7.3.2
activityactivity{}No Action or event related to a record.7.3.2
activity.attributeValuestringNo The value of an activity attribute.7.3.2
activity.descriptionstringNo The description of the record or item.7.3.2
activity.namestringNo The full name for the application contact.7.3.2
activity.typestringNo The activity type.7.3.2
addressaddress{}No The address of the subject.7.3.2
address.addressLine1stringNo The first line of the address. 7.3.2
address.addressLine2stringNo The second line of the address.7.3.2
address.addressLine3stringNo The third line of the address.7.3.2
address.citystringNo The name of the city.7.3.2
address.countryaddress.country{}No Get All Address Countries The name of the country.7.3.2
address.country.textstringNo The localized display text.7.3.2
address.country.valuestringNo The value for the specified parameter.7.3.2
address.postalCodestringNo The postal ZIP code for the address.7.3.2
address.stateaddress.state{}No Get All Address States The state corresponding to the address on record.7.3.2
address.state.textstringNo The localized display text.7.3.2
address.state.valuestringNo The value for the specified parameter.7.3.2
birthCitybirthCity{}No The city of birth for an individual.7.3.2
birthCity.textstringNo The localized display text.7.3.2
birthCity.valuestringNo The value for the specified parameter.7.3.2
birthDateFromdateTimeNo The start of a birth date range to search.7.3.2
birthDateTodateTimeNo The end of a birth date range to search.7.3.2
birthRegionbirthRegion{}No The country of birth or region of birth for an individual.7.3.2
birthRegion.textstringNo The localized display text.7.3.2
birthRegion.valuestringNo The value for the specified parameter.7.3.2
birthStatebirthState{}No Get All Address States The state of birth for an individual.7.3.2
birthState.textstringNo The localized display text.7.3.2
birthState.valuestringNo The value for the specified parameter.7.3.2
businessNamestringNo A secondary business name for the applicable individual.7.3.2
contactAddresscontactAddress{}No The address of the contact.7.3.2
contactAddress.addressLine1stringNo The first line of the address. 7.3.2
contactAddress.addressLine2stringNo The second line of the address.7.3.2
contactAddress.addressLine3stringNo The third line of the address.7.3.2
contactAddress.citystringNo The name of the city.7.3.2
contactAddress.countrycontactAddress.country{}No Get All Address Countries The name of the country.7.3.2
contactAddress.country.textstringNo The localized display text.7.3.2
contactAddress.country.valuestringNo The value for the specified parameter.7.3.2
contactAddress.directioncontactAddress.direction{}No Get All Address Street Directions The street direction of the primary address associated with the application.7.3.2
contactAddress.direction.textstringNo The localized display text.7.3.2
contactAddress.direction.valuestringNo The value for the specified parameter.7.3.2
contactAddress.faxstringNo The fax number for the contact.7.3.2
contactAddress.faxCountryCodestringNo Fax Number Country Code7.3.2
contactAddress.houseAlphaEndstringNo The ending street number that makes up the address.7.3.2
contactAddress.houseAlphaStartstringNo The beginning street number that makes up the address.7.3.2
contactAddress.idlongNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
contactAddress.levelEndstringNo The ending level number (floor number) that makes up the address within a complex.7.3.2
contactAddress.levelPrefixstringNo The prefix for the level numbers (floor numbers) that make up the address.7.3.2
contactAddress.levelStartstringNo The beginning level number (floor number) that makes up the address within a complex.7.3.2
contactAddress.phonestringNo The telephone number of the user. 7.3.2
contactAddress.phoneCountryCodestringNo The country code for the assoicated phone number.7.3.2
contactAddress.postalCodestringNo The postal ZIP code for the address.7.3.2
contactAddress.recipientstringNo The contact person for the contact address.7.3.2
contactAddress.statecontactAddress.state{}No Get All Address States The state corresponding to the address on record.7.3.2
contactAddress.state.textstringNo The localized display text.7.3.2
contactAddress.state.valuestringNo The value for the specified parameter.7.3.2
contactAddress.statuscontactAddress.status{}NoA | IThe address status indicating whether the address is active or inactive.7.3.2
contactAddress.status.textstringNo The localized display text.7.3.2
contactAddress.status.valuestringNo The value for the specified parameter.7.3.2
contactAddress.streetAddressstringNo The street address. 7.3.2
contactAddress.streetEndlongNo The end of a range of street numbers.7.3.2
contactAddress.streetNamestringNo The street name for the address.7.3.2
contactAddress.streetPrefixstringNo 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.streetStartlongNo The start of a range of street numbers.7.3.2
contactAddress.streetSuffixcontactAddress.streetSuffix{}No Get All Address Street Suffixes The type of street such as "Lane" or "Boulevard".7.3.2
contactAddress.streetSuffix.textstringNo The localized display text.7.3.2
contactAddress.streetSuffix.valuestringNo The value for the specified parameter.7.3.2
contactAddress.streetSuffixDirectioncontactAddress.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.textstringNo The localized display text.7.3.2
contactAddress.streetSuffixDirection.valuestringNo The value for the specified parameter.7.3.2
contactAddress.typecontactAddress.type{}No Get All Address Unit Types The address type.7.3.2
contactAddress.type.textstringNo The localized display text.7.3.2
contactAddress.type.valuestringNo The value for the specified parameter.7.3.2
contactAddress.unitEndstringNo The end parameter of a range of unit numbers.7.3.2
contactAddress.unitStartstringNo The starting parameter of a range of unit numbers.7.3.2
contactAddress.unitTypecontactAddress.unitType{}No Get All Address Unit Types The unit type designation of the address.7.3.2
contactAddress.unitType.textstringNo The localized display text.7.3.2
contactAddress.unitType.valuestringNo The value for the specified parameter.7.3.2
deceasedDateFromdateTimeNo The start of a deceased date range to search.7.3.2
deceasedDateTodateTimeNo The end of a deceased date range to search.7.3.2
driverLicenseNumberstringNo The driver's license number of the contact. This field is active only when the Contact Type selected is Individual.7.3.2
driverLicenseStatedriverLicenseState{}No Get All Address States The state that issued the driver's license.7.3.2
driverLicenseState.textstringNo The localized display text.7.3.2
driverLicenseState.valuestringNo The value for the specified parameter.7.3.2
emailstringNo The contact's email address.7.3.2
faxstringNo The fax number for the contact.7.3.2
faxCountryCodestringNo Fax Number Country Code7.3.2
federalEmployerIdstringNo The Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.2
firstNamestringNo The contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
fullNamestringNo The contact's full name. This field is only active when the Contact Type selected is Individual.7.3.2
gendergender{}No The gender (male or female) of the individual.7.3.2
gender.textstringNo The localized display text.7.3.2
gender.valuestringNo The value for the specified parameter.7.3.2
idstringNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
individualOrOrganizationstringNo The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.2
lastNamestringNo The last name (surname). 7.3.2
middleNamestringNo The middle name. 7.3.2
openCloseMatchstringNo Indicates whether or not to use close matches as hits in a search for contacts.7.3.2
openSoundexSearchstringNoY | NIndicates whether or not Soundex search is enabled for any of the following requested parameters: firstName, middleName, lastName, organizationName, tradeName, businessName, streetName7.3.3.4
orderBystringNoLastName 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 DESCThe 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
organizationNamestringNo The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.2
passportNumberstringNo The contact's passport number. This field is only active when the Contact Type selected is Individual.7.3.2
phone1stringNo The primary telephone number of the contact. 7.3.2
phone1CountryCodestringNo Phone Number 1 Country Code7.3.2
phone2stringNo The secondary telephone number of the contact.7.3.2
phone2CountryCodestringNo Phone Number 2 Country Code7.3.2
phone3stringNo The tertiary telephone number for the contact.7.3.2
phone3CountryCodestringNo Phone Number 3 Country Code7.3.2
postOfficeBoxstringNo The post office box number.7.3.2
preferredChannelpreferredChannel{}No Get All Contact Preferred Channels The method by which the contact prefers to be notified, by phone for example.7.3.2
preferredChannel.textstringNo The localized display text.7.3.2
preferredChannel.valuestringNo The value for the specified parameter.7.3.2
racerace{}No Get All Contact Races The contact's race or ethnicity.7.3.2
race.textstringNo The localized display text.7.3.2
race.valuestringNo The value for the specified parameter.7.3.2
relationrelation{}No The contact's relationship to the application or service request.7.3.2
relation.textstringNo The localized display text.7.3.2
relation.valuestringNo The value for the specified parameter.7.3.2
salutationsalutation{}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.textstringNo The localized display text.7.3.2
salutation.valuestringNo The value for the specified parameter.7.3.2
serviceProviderCodestringNo The unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
socialSecurityNumberstringNo The individual's social security number. This field is only active when the Contact Type selected is Individual.7.3.2
stateIdNumberstringNo The contact's state ID number. This field is only active when the Contact Type selected is Individual.7.3.2
statusstatus{}No The contact status.7.3.2
status.textstringNo The localized display text.7.3.2
status.valuestringNo The value for the specified parameter.7.3.2
suffixstringNo The contact name suffix.7.3.2
titlestringNo The individual's business title. 7.3.2
tradeNamestringNo The contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization.7.3.2
typetype{}No The people type.7.3.2
type.textstringNo The localized display text.7.3.2
type.valuestringNo 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

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.additionalAddresses[]result.additionalAddresses{}Additional address information.7.3.2
result.addressresult.address{}The citizen user's address.7.3.2
result.address.addressLine1stringThe first line of the address. 7.3.2
result.address.addressLine2stringThe second line of the address.7.3.2
result.address.addressLine3stringThe third line of the address.7.3.2
result.address.citystringThe name of the city.7.3.2
result.address.countryresult.address.country{}The name of the country.7.3.2
result.address.country.textstringThe localized display text.7.3.2
result.address.country.valuestringThe value for the specified parameter.7.3.2
result.address.postalCodestringThe postal ZIP code for the address.7.3.2
result.address.stateresult.address.state{}The state corresponding to the address on record.7.3.2
result.address.state.textstringThe localized display text.7.3.2
result.address.state.valuestringThe value for the specified parameter.7.3.2
result.birthCityresult.birthCity{}The city of birth for an individual.7.3.2
result.birthCity.textstringThe localized display text.7.3.2
result.birthCity.valuestringThe value for the specified parameter.7.3.2
result.birthDatedateTimeThe birth date of an individual.7.3.2
result.birthRegionresult.birthRegion{}The country of birth or region of birth for an individual.7.3.2
result.birthRegion.textstringThe localized display text.7.3.2
result.birthRegion.valuestringThe value for the specified parameter.7.3.2
result.birthStateresult.birthState{}The state of birth for an individual.7.3.2
result.birthState.textstringThe localized display text.7.3.2
result.birthState.valuestringThe value for the specified parameter.7.3.2
result.businessNamestringA secondary business name for the applicable individual.7.3.2
result.commentstringComments or notes about the current context.7.3.2
result.deceasedDatedateTimeThe date of death. This field is active only when the Contact Type selected is Individual.7.3.2
result.driverLicenseNumberstringThe driver's license number of the contact. This field is active only when the Contact Type selected is Individual.7.3.2
result.driverLicenseStateresult.driverLicenseState{}The state that issued the driver's license.7.3.2
result.driverLicenseState.textstringThe localized display text.7.3.2
result.driverLicenseState.valuestringThe value for the specified parameter.7.3.2
result.emailstringThe contact's email address.7.3.2
result.faxstringThe fax number for the contact.7.3.2
result.faxCountryCodestringFax Number Country Code7.3.2
result.federalEmployerIdstringThe Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.2
result.firstNamestringThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
result.fullNamestringThe contact's full name. This field is only active when the Contact Type selected is Individual.7.3.2
result.genderresult.gender{}The gender (male or female) of the individual.7.3.2
result.gender.textstringThe localized display text.7.3.2
result.gender.valuestringThe value for the specified parameter.7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.individualOrOrganizationstringThe organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.2
result.lastNamestringThe last name (surname). 7.3.2
result.middleNamestringThe middle name. 7.3.2
result.organizationNamestringThe organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.2
result.passportNumberstringThe contact's passport number. This field is only active when the Contact Type selected is Individual.7.3.2
result.phone1stringThe primary telephone number of the contact. 7.3.2
result.phone1CountryCodestringPhone Number 1 Country Code7.3.2
result.phone2stringThe secondary telephone number of the contact.7.3.2
result.phone2CountryCodestringPhone Number 2 Country Code7.3.2
result.phone3stringThe tertiary telephone number for the contact.7.3.2
result.phone3CountryCodestringPhone Number 3 Country Code7.3.2
result.postOfficeBoxstringThe post office box number.7.3.2
result.preferredChannelresult.preferredChannel{}The method by which the contact prefers to be notified, by phone for example.7.3.2
result.preferredChannel.textstringThe localized display text.7.3.2
result.preferredChannel.valuestringThe value for the specified parameter.7.3.2
result.raceresult.race{}The contact's race/ethnicity.7.3.2
result.race.textstringThe localized display text.7.3.2
result.race.valuestringThe value for the specified parameter.7.3.2
result.relationresult.relation{}The contact's relationship to the application or service request.7.3.2
result.relation.textstringThe localized display text.7.3.2
result.relation.valuestringThe value for the specified parameter.7.3.2
result.salutationresult.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.textstringThe localized display text.7.3.2
result.salutation.valuestringThe value for the specified parameter.7.3.2
result.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.socialSecurityNumberstringThe individual's social security number. This field is only active when the Contact Type selected is Individual.7.3.2
result.stateIdNumberstringThe contact's state ID number. This field is only active when the Contact Type selected is Individual.7.3.2
result.statusresult.status{}The contact status.7.3.2
result.status.textstringThe localized display text.7.3.2
result.status.valuestringThe value for the specified parameter.7.3.2
result.suffixstringThe contact name suffix.7.3.2
result.titlestringThe individual's business title. 7.3.2
result.tradeNamestringThe contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization.7.3.2
result.typeresult.type{}The type of people to contact. 7.3.2
result.type.textstringThe localized display text.7.3.2
result.type.valuestringThe value for the specified parameter.7.3.2
statusintegerThe 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
  }
}