Get All Contacts

Gets all contacts available in the system.

Resource Information

Scopecontacts

Deprecated scope name:   get_contacts

App TypeAll
Authorization TypeAccess 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 MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
addressLine1stringNoThe first line of the address. 7.3.2
addressLine2stringNoThe second line of the address.7.3.2
addressLine3stringNoThe third line of the address.7.3.2
businessNamestringNoA secondary business name for the applicable individual.7.3.2
citystringNoThe name of the city.7.3.2
countrystringNo Get All Address Countries The name of the country.7.3.2
emailstringNoThe contact's email address.7.3.2
fieldsstringNoComma-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
firstNamestringNoThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
langStringNoIndicates the language applied.7.3.2
lastNamestringNoThe last name (surname). 7.3.2
limitlongNoIndicates the number of items that are returned in each page.7.3.2
middleNamestringNoThe middle name. 7.3.2
offsetlongNoIndicates the offset start of each page by the number specified.7.3.2
statestringNo Get All Address States The state corresponding to the address on record.7.3.2
titlestringNoThe 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

FieldTypeDescriptionAutomation Version
result[]result{}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

{
  "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
  }
}