Get All Contacts

Gets all contacts available in the system.

Resource Information

Scope	contacts Deprecated scope name: get_contacts
App Type	All
Authorization Type	Access token
URI	/v4/contacts?lang={lang}&state={state}&country={country}&firstName={firstName}&middleName={middleName}&lastName={lastName}&email={email}&addressLine1={addressLine1}&addressLine2={addressLine2}&addressLine3={addressLine3}&businessName={businessName}&city={city}&title={title}&offset={offset}&limit={limit}&fields={fields}
HTTP Method	GET
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
addressLine1	string	No	�	The first line of the address.	7.3.2
addressLine2	string	No	�	The second line of the address.	7.3.2
addressLine3	string	No	�	The third line of the address.	7.3.2
businessName	string	No	�	A secondary business name for the applicable individual.	7.3.2
city	string	No	�	The name of the city.	7.3.2
country	string	No	Get All Address Countries	The name of the country.	7.3.2
email	string	No	�	The contact's email address.	7.3.2
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
firstName	string	No	�	The contact's first name. This field is only active when the Contact Type selected is Individual.	7.3.2
lang	String	No	�	Indicates the language applied.	7.3.2
lastName	string	No	�	The last name (surname).	7.3.2
limit	long	No	�	Indicates the number of items that are returned in each page.	7.3.2
middleName	string	No	�	The middle name.	7.3.2
offset	long	No	�	Indicates the offset start of each page by the number specified.	7.3.2
state	string	No	Get All Address States	The state corresponding to the address on record.	7.3.2
title	string	No	�	The individual's business title.	7.3.2

Example

Sample Request Head

GET https://apis.accela.com/v4/contacts?city=Watsonville

Notes

The following sample request uses the ISLANDTON agency in the TEST environment on the Accela Developer Sandbox. Click the "Send to Hurl.It" link below to submit the sample request. Replace YOUR-ACCESS-TOKEN before submitting the request.

curl
   -H 'Content-type: application/json'
   -H 'Accept: application/json'
   -H 'Authorization: YOUR-ACCESS-TOKEN'
   -X GET https://apis.accela.com/v4/contacts?city=Watsonville

Response Information

Field	Type	Description	Automation Version
result[]	result{}	�	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

{
  "status": 200,
  "result": [
    {
      "email": "danevuspex@gmail.com",
      "individualOrOrganization": "N",
      "serviceProviderCode": "ISLANDTON",
      "id": "910487",
      "organizationName": "Building contractor",
      "fax": "8317284769",
      "phone3": "8315888301",
      "firstName": "Dane",
      "lastName": "Vuspex",
      "type": {
        "value": "Individual",
        "text": "Individual"
      },
      "status": {
        "value": "A",
        "text": "Active"
      },
      "address": {
        "city": "Watsonville",
        "postalCode": "95076",
        "addressLine1": "125 Hangar Way, Suite 210",
        "country": {
          "value": "US",
          "text": "United States"
        },
        "state": {
          "value": "CA",
          "text": "CA"
        }
      }
    }
  ],
  "page": {
    "offset": 0,
    "limit": 25,
    "hasmore": false
  }
}