Search Owners

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

Resource Information

Scopeowners

Deprecated scope name:   search_owners

App TypeAll
Authorization TypeAccess token
URI /v4/search/owners?lang={lang}&offset={offset}&limit={limit}&fields={fields}
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
addressaddress{}No The address of the subject.7.3.2
address.addressLine1stringNo The first 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
emailstringNo The contact's email address.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
lastNamestringNo The last name (surname). 7.3.2
mailAddressmailAddress{}No Contains the fields that define an owner's address.7.3.2
mailAddress.addressLine1stringNo The first line of the address. 7.3.2
mailAddress.citystringNo The name of the city.7.3.2
mailAddress.postalCodestringNo The postal ZIP code for the address.7.3.2
mailAddress.statemailAddress.state{}No Get All Address States The state corresponding to the address on record.7.3.2
mailAddress.state.textstringNo The localized display text.7.3.2
mailAddress.state.valuestringNo The value for the specified parameter.7.3.2
parcelIdstringNo The unique Id generated for a parcel.7.3.2
statusstatus{}No The owner status.7.3.2
status.textstringNo The localized display text.7.3.2
status.valuestringNo The value for the specified parameter.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.addressresult.address{}The address of the subject.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.emailstringThe contact's email address.7.3.2
result.faxstringThe fax number for the contact.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.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.isPrimarystringIndicates whether or not to designate the owner as the primary owner.7.3.2
result.lastNamestringThe last name (surname). 7.3.2
result.mailAddressresult.mailAddress{}Contains the fields that define an owner's address.7.3.2
result.mailAddress.addressLine1stringThe first line of the address. 7.3.2
result.mailAddress.addressLine2stringThe second line of the address.7.3.2
result.mailAddress.addressLine3stringThe third line of the address.7.3.2
result.mailAddress.citystringThe name of the city.7.3.2
result.mailAddress.countryresult.mailAddress.country{}The name of the country.7.3.2
result.mailAddress.country.textstringThe localized display text.7.3.2
result.mailAddress.country.valuestringThe value for the specified parameter.7.3.2
result.mailAddress.postalCodestringThe postal ZIP code for the address.7.3.2
result.mailAddress.stateresult.mailAddress.state{}The state corresponding to the address on record.7.3.2
result.mailAddress.state.textstringThe localized display text.7.3.2
result.mailAddress.state.valuestringThe value for the specified parameter.7.3.2
result.middleNamestringThe middle name. 7.3.2
result.parcelIdstringThe unique Id generated for a parcel.7.3.2
result.phonestringThe telephone number of the owner. 7.3.2
result.phoneCountryCodestringThe country code for the assoicated phone number.7.3.2
result.recordIdresult.recordId{}The unique ID associated with a record.7.3.2
result.recordId.customIdstringAn 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.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.recordId.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.recordId.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
result.recordId.valuestringThe value for the specified parameter.7.3.2
result.statusresult.status{}The owner 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.structureNamestringThe name of the full or partial structure or establishment.7.3.2
result.structureTypestringThe type of structure or establishment7.3.2
result.taxIdstringThe owner's tax ID number.7.3.2
result.titlestringThe individual's business title. 7.3.2
statusintegerThe record status.7.3.3