Get All Contacts for Record

Gets the contacts for a specified record.

Resource Information

Scope	records Deprecated scope name: get_record_contacts
App Type	All
Authorization Type	Access token
URI	/v4/records/{recordId}/contacts?lang={lang}&fields={fields}
HTTP Method	GET
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
recordId	string	Yes	Get All Records Search Records Get My Records	The unique ID associated with a record.	7.3.2

Response Information

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.2
result.address	result.address{}	The address of the subject.	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.endDate	dateTime	The date when the contact address ceases to be active.	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.isPrimary	string	Indicates whether or not to designate the contact as the primary contact Only one address can be primary at any given time.	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.recordId	result.recordId{}	The unique ID associated with a record.	7.3.2
result.recordId.customId	string	An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.	7.3.2
result.recordId.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.recordId.serviceProviderCode	string	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
result.recordId.trackingId	long	The application tracking number (IVR tracking number).	7.3.2
result.recordId.value	string	The value for the specified parameter.	7.3.2
result.referenceContactId	string	The unique Id generated for a contact stored in the sytem.	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.socialSecurityNumber	string	The individual's social security number. This field is only active when the Contact Type selected is Individual.	7.3.2
result.startDate	dateTime	The date the contact became active.	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 contact type.	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