Get All Parcels

Gets a list of parcels in the agency database. Specify at least one filter criteria.

Resource Information

Scope	parcels Deprecated scope name: get_parcels
App Type	All
Authorization Type	No authorization required
URI	/v4/parcels?streetStart={streetStart}&section={section}&streetName={streetName}&streetType={streetType}&range={range}&isPrimary={isPrimary}&fullName={fullName}&city={city}&township={township}&parcelNumber={parcelNumber}&streetEnd={streetEnd}&lot={lot}&offset={offset}&limit={limit}&lang={lang}&fields={fields}
HTTP Method	GET
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
city	string	No	�	The name of the city.	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
fullName	string	No	�	The contact's full name. This field is only active when the Contact Type selected is Individual.	7.3.2
isPrimary	string	No	Y \| N	Indicates whether or not to designate the address as the primary address. Only one address can be primary at any given time.	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
lot	string	No	�	This is the lot name.	7.3.2
offset	long	No	�	Indicates the offset start of each page by the number specified.	7.3.2
parcelNumber	string	No	�	The localized display text.	7.3.2
range	string	No	�	When land is surveyed using the rectangular-survey system, range represents the measure of units east and west of the base line.	7.3.2
section	long	No	�	A piece of a township measuring 640 acres, one square mile, numbered with reference to the base line and meridian line.	7.3.2
streetEnd	long	No	�	The end of a range of street numbers.	7.3.2
streetName	string	No	�	The street name for the address.	7.3.2
streetStart	long	No	�	The start of a range of street numbers.	7.3.2
streetType	string	No	�	Standard street categories, for example avenue, boulevard, circle, and so forth.	7.3.2
subdivision	string	No	�	The name of the subdivision.	7.3.2
township	string	No	�	When land is surveyed using the rectangular-survey system, township represents the measure of units North or South of the base line. Townships typically measure 6 miles to a side, or 36 square miles.	7.3.2

Example

Sample Request Head

GET https://apis.accela.com//v4/parcels?isPrimary=Y

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/parcels?isPrimary=Y

Response Information

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.2
result.addresses[]	result.addresses{}	Contains one or more address information	7.3.2
result.addresses.addressLine1	string	The first line of the address.	7.3.2
result.addresses.addressLine2	string	The second line of the address.	7.3.2
result.addresses.addressTypeFlag	result.addresses.addressTypeFlag{}	The status of the address record indicating whether the address is active or inactive.	7.3.2
result.addresses.addressTypeFlag.text	string	The localized display text.	7.3.2
result.addresses.addressTypeFlag.value	string	The value for the specified parameter.	7.3.2
result.addresses.auditStatus	string	The status of this address record.	7.3.2
result.addresses.city	string	The name of the city.	7.3.2
result.addresses.country	result.addresses.country{}	The name of the country.	7.3.2
result.addresses.country.text	string	The localized display text.	7.3.2
result.addresses.country.value	string	The value for the specified parameter.	7.3.2
result.addresses.county	string	The name of the county.	7.3.2
result.addresses.description	string	The description of the record or item.	7.3.2
result.addresses.direction	result.addresses.direction{}	The street direction of the primary address associated with the application.	7.3.2
result.addresses.direction.text	string	The localized display text.	7.3.2
result.addresses.direction.value	string	The value for the specified parameter.	7.3.2
result.addresses.distance	double	The distance from another landmark used to locate the address.	7.3.2
result.addresses.houseAlphaEnd	string	The ending street number that makes up the address.	7.3.2
result.addresses.houseAlphaStart	string	The beginning street number that makes up the address.	7.3.2
result.addresses.houseFractionEnd	result.addresses.houseFractionEnd{}	Used in combination with the Street # fields.	7.3.2
result.addresses.houseFractionEnd.text	string	The localized display text.	7.3.2
result.addresses.houseFractionEnd.value	string	The value for the specified parameter.	7.3.2
result.addresses.houseFractionStart	result.addresses.houseFractionStart{}	Used In combination with the Street # fields.	7.3.2
result.addresses.houseFractionStart.text	string	The localized display text.	7.3.2
result.addresses.houseFractionStart.value	string	The value for the specified parameter.	7.3.2
result.addresses.houseNumberEndFrom	long	The first of the ending house number range.	7.3.2
result.addresses.houseNumberEndTo	long	The last of the ending house number range.	7.3.2
result.addresses.houseNumberStartFrom	long	The first of the start house number range.	7.3.2
result.addresses.houseNumberStartTo	long	The last of the start house number range.	7.3.2
result.addresses.id	long	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.addresses.inspectionDistrict	string	The inspection district where the address is located.	7.3.2
result.addresses.inspectionDistrictPrefix	string	The prefix for the inspection district where the address is located.	7.3.2
result.addresses.isPrimary	string	This defines whether or not to designate the address as the primary address. Only one address can be primary at any given time.	7.3.2
result.addresses.levelEnd	string	The ending level number (floor number) that makes up the address within a complex.	7.3.2
result.addresses.levelPrefix	string	The prefix for the level numbers (floor numbers) that make up the address.	7.3.2
result.addresses.levelStart	string	The beginning level number (floor number) that makes up the address within a complex.	7.3.2
result.addresses.neighborhood	string	The neighborhood where the address is located.	7.3.2
result.addresses.neighborhoodPrefix	string	The prefix for the neighborhood where the address is located.	7.3.2
result.addresses.postalCode	string	The postal ZIP code for the address.	7.3.2
result.addresses.secondaryStreet	string	This field (along with the Secondary Road Number field) displays an extra description for the location when two roads that cross or a street with two names makes up the address of the location.	7.3.2
result.addresses.secondaryStreetNumber	long	This field (along with the Secondary Road field) displays an extra description for the location when two roads that cross or a street with two names makes up the address of the location.	7.3.2
result.addresses.sourceFlag	string	The Accela permitting system that stores this address information.	7.3.2
result.addresses.sourceNumber	long	A number that idenfies the source of APO (address, parcel, and owner) information. The system supports sharing of APO data from other agencies that use the Accela Civic Platform.	7.3.2
result.addresses.state	result.addresses.state{}	The state corresponding to the address on record.	7.3.2
result.addresses.state.text	string	The localized display text.	7.3.2
result.addresses.state.value	string	The value for the specified parameter.	7.3.2
result.addresses.status	result.addresses.status{}	The address status indicating whether the address is active or inactive.	7.3.2
result.addresses.status.text	string	The localized display text.	7.3.2
result.addresses.status.value	string	The value for the specified parameter.	7.3.2
result.addresses.streetAddress	string	The street address.	7.3.2
result.addresses.streetEnd	long	The end of a range of street numbers.	7.3.2
result.addresses.streetName	string	The street name for the address.	7.3.2
result.addresses.streetPrefix	string	Any part of an address that appears before a street name or number. For example, if the address is 123 West Main, "West" is the street prefix.	7.3.2
result.addresses.streetStart	long	The start of a range of street numbers.	7.3.2
result.addresses.streetSuffix	result.addresses.streetSuffix{}	The type of street such as "Lane" or "Boulevard".	7.3.2
result.addresses.streetSuffix.text	string	The localized display text.	7.3.2
result.addresses.streetSuffix.value	string	The value for the specified parameter.	7.3.2
result.addresses.streetSuffixDirection	result.addresses.streetSuffixDirection{}	The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW" is the street suffix direction.	7.3.2
result.addresses.streetSuffixDirection.text	string	The localized display text.	7.3.2
result.addresses.streetSuffixDirection.value	string	The value for the specified parameter.	7.3.2
result.addresses.unitEnd	string	The end parameter of a range of unit numbers.	7.3.2
result.addresses.unitStart	string	The starting parameter of a range of unit numbers.	7.3.2
result.addresses.unitType	result.addresses.unitType{}	The unit type designation of the address.	7.3.2
result.addresses.unitType.text	string	The localized display text.	7.3.2
result.addresses.unitType.value	string	The value for the specified parameter.	7.3.2
result.addresses.xCoordinate	double	The longitudinal coordinate for this address.	7.3.2
result.addresses.yCoordinate	double	The latitudinal coordinate for this address.	7.3.2
result.block	string	The block number associated with the parcel.	7.3.2
result.book	string	A reference to the physical location of parcel information in the County Assessor's office.	7.3.2
result.censusTract	string	The unique number assigned by the Census Bureau that identifies the tract to which this parcel belongs.	7.3.2
result.councilDistrict	string	The council district to which the parcel belongs.	7.3.2
result.exemptionValue	double	The total value of any tax exemptions that apply to the land within the parcel.	7.3.2
result.gisSequenceNumber	long	This is the ID number that you use to identify the parcel in Geographic Information Systems (GIS).	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.improvedValue	double	This is the total value of any improvements to the land within the parcel.	7.3.2
result.isPrimary	string	Indicates whether or not to designate the parcel as the primary parcel.	7.3.2
result.landValue	double	This is the total value of the land within the parcel.	7.3.2
result.legalDescription	string	The legal description of the parcel.	7.3.2
result.lot	string	This is the lot name.	7.3.2
result.mapNumber	string	The unique map number that identifies the map for this parcel.	7.3.2
result.mapReferenceInfo	string	The reference to where the map for this parcel exists.	7.3.2
result.owners[]	result.owners{}	Contains the fields that define an owner.	7.3.2
result.owners.address	result.owners.address{}	The address of the subject.	7.3.2
result.owners.address.addressLine1	string	The first line of the address.	7.3.2
result.owners.address.addressLine2	string	The second line of the address.	7.3.2
result.owners.address.addressLine3	string	The third line of the address.	7.3.2
result.owners.address.city	string	The name of the city.	7.3.2
result.owners.address.country	result.owners.address.country{}	The name of the country.	7.3.2
result.owners.address.country.text	string	The localized display text.	7.3.2
result.owners.address.country.value	string	The value for the specified parameter.	7.3.2
result.owners.address.postalCode	string	The postal ZIP code for the address.	7.3.2
result.owners.address.state	result.owners.address.state{}	The state corresponding to the address on record.	7.3.2
result.owners.address.state.text	string	The localized display text.	7.3.2
result.owners.address.state.value	string	The value for the specified parameter.	7.3.2
result.owners.email	string	The contact's email address.	7.3.2
result.owners.fax	string	The fax number for the contact.	7.3.2
result.owners.firstName	string	The contact's first name. This field is only active when the Contact Type selected is Individual.	7.3.2
result.owners.fullName	string	The contact's full name. This field is only active when the Contact Type selected is Individual.	7.3.2
result.owners.id	long	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.owners.isPrimary	string	Indicates whether or not to designate the owner as the primary owner.	7.3.2
result.owners.lastName	string	The last name (surname).	7.3.2
result.owners.mailAddress	result.owners.mailAddress{}	Contains the fields that define an owner's address.	7.3.2
result.owners.mailAddress.addressLine1	string	The first line of the address.	7.3.2
result.owners.mailAddress.addressLine2	string	The second line of the address.	7.3.2
result.owners.mailAddress.addressLine3	string	The third line of the address.	7.3.2
result.owners.mailAddress.city	string	The name of the city.	7.3.2
result.owners.mailAddress.country	result.owners.mailAddress.country{}	The name of the country.	7.3.2
result.owners.mailAddress.country.text	string	The localized display text.	7.3.2
result.owners.mailAddress.country.value	string	The value for the specified parameter.	7.3.2
result.owners.mailAddress.postalCode	string	The postal ZIP code for the address.	7.3.2
result.owners.mailAddress.state	result.owners.mailAddress.state{}	The state corresponding to the address on record.	7.3.2
result.owners.mailAddress.state.text	string	The localized display text.	7.3.2
result.owners.mailAddress.state.value	string	The value for the specified parameter.	7.3.2
result.owners.middleName	string	The middle name.	7.3.2
result.owners.parcelId	string	The unique Id generated for a parcel.	7.3.2
result.owners.phone	string	The telephone number of the owner.	7.3.2
result.owners.phoneCountryCode	string	The country code for the assoicated phone number.	7.3.2
result.owners.recordId	result.owners.recordId{}	The unique ID associated with a record.	7.3.2
result.owners.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.owners.recordId.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.owners.recordId.serviceProviderCode	string	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
result.owners.recordId.trackingId	long	The application tracking number (IVR tracking number).	7.3.2
result.owners.recordId.value	string	The value for the specified parameter.	7.3.2
result.owners.status	result.owners.status{}	The owner status.	7.3.2
result.owners.status.text	string	The localized display text.	7.3.2
result.owners.status.value	string	The value for the specified parameter.	7.3.2
result.owners.structureName	string	The name of the full or partial structure or establishment.	7.3.2
result.owners.structureType	string	The type of structure or establishment	7.3.2
result.owners.taxId	string	The owner's tax ID number.	7.3.2
result.owners.title	string	The individual's business title.	7.3.2
result.page	string	A reference to the physical location of the parcel information in the records of the County Assessor (or other responsible department).	7.3.2
result.parcel	string	The official parcel name or number, as determined by the county assessor or other responsible department.	7.3.2
result.parcelArea	double	The total area of the parcel. Your agency determines the standard unit of measure.	7.3.2
result.parcelNumber	string	The localized display text.	7.3.2
result.planArea	string	The total area of the parcel. Your agency determines the standard unit of measure.	7.3.2
result.range	string	When land is surveyed using the rectangular-survey system, range represents the measure of units east and west of the base line.	7.3.2
result.section	long	A piece of a township measuring 640 acres, one square mile, numbered with reference to the base line and meridian line.	7.3.2
result.status	result.status{}	The parcel 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.subdivision	result.subdivision{}	The name of the subdivision.	7.3.2
result.subdivision.text	string	The localized display text.	7.3.2
result.subdivision.value	string	The value for the specified parameter.	7.3.2
result.supervisorDistrict	string	The supervisor district to which the parcel belongs.	7.3.2
result.township	string	When land is surveyed using the rectangular-survey system, township represents the measure of units North or South of the base line. Townships typically measure 6 miles to a side, or 36 square miles.	7.3.2
result.tract	string	The name of the tract associated with this application. A tract may contain one or more related parcels.	7.3.2
status	integer	The record status.	7.3.3

Example

Sample Response Body

{
  "status": 200,
  "result": [
    {
      "range": "55",
      "block": "1234",
      "parcelNumber": "005010007",
      "isPrimary": "Y",
      "legalDescription": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
      "lot": "55",
      "section": 22,
      "township": "Pet",
      "id": "005010007",
      "parcelArea": 2178000,
      "status": {
        "value": "A",
        "text": "Active"
      },
      "subdivision": {
        "value": "CloverDale",
        "text": "CloverDale"
      }
    },
    {
      "parcelNumber": "4008007856",
      "isPrimary": "Y",
      "legalDescription": "Squaw Creek Road",
      "id": "4008007856",
      "status": {
        "value": "A",
        "text": "Active"
      }
    }
  ],
  "page": {
    "offset": 0,
    "limit": 25,
    "hasmore": false
  }
}