Search Owners

Finds the owners that match the search criteria. Specify at least one search criteria.

Resource Information

Scope	owners Deprecated scope name: search_owners
App Type	All
Authorization Type	Access token
URI	/v4/search/owners?lang={lang}&offset={offset}&limit={limit}&fields={fields}
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
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.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
email	string	No	�	The contact's email address.	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
lastName	string	No	�	The last name (surname).	7.3.2
mailAddress	mailAddress{}	No	�	Contains the fields that define an owner's address.	7.3.2
mailAddress.addressLine1	string	No	�	The first line of the address.	7.3.2
mailAddress.city	string	No	�	The name of the city.	7.3.2
mailAddress.postalCode	string	No	�	The postal ZIP code for the address.	7.3.2
mailAddress.state	mailAddress.state{}	No	Get All Address States	The state corresponding to the address on record.	7.3.2
mailAddress.state.text	string	No	�	The localized display text.	7.3.2
mailAddress.state.value	string	No	�	The value for the specified parameter.	7.3.2
parcelId	string	No	�	The unique Id generated for a parcel.	7.3.2
status	status{}	No	�	The owner 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

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.email	string	The contact's email address.	7.3.2
result.fax	string	The fax number for the contact.	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.id	long	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.isPrimary	string	Indicates whether or not to designate the owner as the primary owner.	7.3.2
result.lastName	string	The last name (surname).	7.3.2
result.mailAddress	result.mailAddress{}	Contains the fields that define an owner's address.	7.3.2
result.mailAddress.addressLine1	string	The first line of the address.	7.3.2
result.mailAddress.addressLine2	string	The second line of the address.	7.3.2
result.mailAddress.addressLine3	string	The third line of the address.	7.3.2
result.mailAddress.city	string	The name of the city.	7.3.2
result.mailAddress.country	result.mailAddress.country{}	The name of the country.	7.3.2
result.mailAddress.country.text	string	The localized display text.	7.3.2
result.mailAddress.country.value	string	The value for the specified parameter.	7.3.2
result.mailAddress.postalCode	string	The postal ZIP code for the address.	7.3.2
result.mailAddress.state	result.mailAddress.state{}	The state corresponding to the address on record.	7.3.2
result.mailAddress.state.text	string	The localized display text.	7.3.2
result.mailAddress.state.value	string	The value for the specified parameter.	7.3.2
result.middleName	string	The middle name.	7.3.2
result.parcelId	string	The unique Id generated for a parcel.	7.3.2
result.phone	string	The telephone number of the owner.	7.3.2
result.phoneCountryCode	string	The country code for the assoicated phone number.	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.status	result.status{}	The owner 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.structureName	string	The name of the full or partial structure or establishment.	7.3.2
result.structureType	string	The type of structure or establishment	7.3.2
result.taxId	string	The owner's tax ID number.	7.3.2
result.title	string	The individual's business title.	7.3.2
status	integer	The record status.	7.3.3