Get All Parcels

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

Resource Information

Scopeparcels

Deprecated scope name:   get_parcels

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

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
citystringNo The name of the city.7.3.2
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
fullNamestringNo The contact's full name. This field is only active when the Contact Type selected is Individual.7.3.2
isPrimarystringNoY | NIndicates whether or not to designate the address as the primary address. Only one address can be primary at any given time.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
lotstringNo This is the lot name.7.3.2
offsetlongNo Indicates the offset start of each page by the number specified.7.3.2
parcelNumberstringNo The localized display text.7.3.2
rangestringNo 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
sectionlongNo A piece of a township measuring 640 acres, one square mile, numbered with reference to the base line and meridian line.7.3.2
streetEndlongNo The end of a range of street numbers.7.3.2
streetNamestringNo The street name for the address.7.3.2
streetStartlongNo The start of a range of street numbers.7.3.2
streetTypestringNo Standard street categories, for example avenue, boulevard, circle, and so forth.7.3.2
subdivisionstringNo The name of the subdivision. 7.3.2
townshipstringNo 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

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.addresses[]result.addresses{}Contains one or more address information7.3.2
result.addresses.addressLine1stringThe first line of the address. 7.3.2
result.addresses.addressLine2stringThe second line of the address.7.3.2
result.addresses.addressTypeFlagresult.addresses.addressTypeFlag{}The status of the address record indicating whether the address is active or inactive.7.3.2
result.addresses.addressTypeFlag.textstringThe localized display text.7.3.2
result.addresses.addressTypeFlag.valuestringThe value for the specified parameter.7.3.2
result.addresses.auditStatusstringThe status of this address record.7.3.2
result.addresses.citystringThe name of the city.7.3.2
result.addresses.countryresult.addresses.country{}The name of the country.7.3.2
result.addresses.country.textstringThe localized display text.7.3.2
result.addresses.country.valuestringThe value for the specified parameter.7.3.2
result.addresses.countystringThe name of the county.7.3.2
result.addresses.descriptionstringThe description of the record or item.7.3.2
result.addresses.directionresult.addresses.direction{}The street direction of the primary address associated with the application.7.3.2
result.addresses.direction.textstringThe localized display text.7.3.2
result.addresses.direction.valuestringThe value for the specified parameter.7.3.2
result.addresses.distancedoubleThe distance from another landmark used to locate the address. 7.3.2
result.addresses.houseAlphaEndstringThe ending street number that makes up the address.7.3.2
result.addresses.houseAlphaStartstringThe beginning street number that makes up the address.7.3.2
result.addresses.houseFractionEndresult.addresses.houseFractionEnd{}Used in combination with the Street # fields.7.3.2
result.addresses.houseFractionEnd.textstringThe localized display text.7.3.2
result.addresses.houseFractionEnd.valuestringThe value for the specified parameter.7.3.2
result.addresses.houseFractionStartresult.addresses.houseFractionStart{}Used In combination with the Street # fields.7.3.2
result.addresses.houseFractionStart.textstringThe localized display text.7.3.2
result.addresses.houseFractionStart.valuestringThe value for the specified parameter.7.3.2
result.addresses.houseNumberEndFromlongThe first of the ending house number range. 7.3.2
result.addresses.houseNumberEndTolongThe last of the ending house number range. 7.3.2
result.addresses.houseNumberStartFromlongThe first of the start house number range. 7.3.2
result.addresses.houseNumberStartTolongThe last of the start house number range. 7.3.2
result.addresses.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.addresses.inspectionDistrictstringThe inspection district where the address is located.7.3.2
result.addresses.inspectionDistrictPrefixstringThe prefix for the inspection district where the address is located.7.3.2
result.addresses.isPrimarystringThis 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.levelEndstringThe ending level number (floor number) that makes up the address within a complex.7.3.2
result.addresses.levelPrefixstringThe prefix for the level numbers (floor numbers) that make up the address.7.3.2
result.addresses.levelStartstringThe beginning level number (floor number) that makes up the address within a complex.7.3.2
result.addresses.neighborhoodstringThe neighborhood where the address is located.7.3.2
result.addresses.neighborhoodPrefixstringThe prefix for the neighborhood where the address is located.7.3.2
result.addresses.postalCodestringThe postal ZIP code for the address.7.3.2
result.addresses.secondaryStreetstringThis 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.secondaryStreetNumberlongThis 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.sourceFlagstringThe Accela permitting system that stores this address information.7.3.2
result.addresses.sourceNumberlongA 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.stateresult.addresses.state{}The state corresponding to the address on record.7.3.2
result.addresses.state.textstringThe localized display text.7.3.2
result.addresses.state.valuestringThe value for the specified parameter.7.3.2
result.addresses.statusresult.addresses.status{}The address status indicating whether the address is active or inactive.7.3.2
result.addresses.status.textstringThe localized display text.7.3.2
result.addresses.status.valuestringThe value for the specified parameter.7.3.2
result.addresses.streetAddressstringThe street address. 7.3.2
result.addresses.streetEndlongThe end of a range of street numbers.7.3.2
result.addresses.streetNamestringThe street name for the address.7.3.2
result.addresses.streetPrefixstringAny 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.streetStartlongThe start of a range of street numbers.7.3.2
result.addresses.streetSuffixresult.addresses.streetSuffix{}The type of street such as "Lane" or "Boulevard".7.3.2
result.addresses.streetSuffix.textstringThe localized display text.7.3.2
result.addresses.streetSuffix.valuestringThe value for the specified parameter.7.3.2
result.addresses.streetSuffixDirectionresult.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.textstringThe localized display text.7.3.2
result.addresses.streetSuffixDirection.valuestringThe value for the specified parameter.7.3.2
result.addresses.unitEndstringThe end parameter of a range of unit numbers.7.3.2
result.addresses.unitStartstringThe starting parameter of a range of unit numbers.7.3.2
result.addresses.unitTyperesult.addresses.unitType{}The unit type designation of the address.7.3.2
result.addresses.unitType.textstringThe localized display text.7.3.2
result.addresses.unitType.valuestringThe value for the specified parameter.7.3.2
result.addresses.xCoordinatedoubleThe longitudinal coordinate for this address. 7.3.2
result.addresses.yCoordinatedoubleThe latitudinal coordinate for this address. 7.3.2
result.blockstringThe block number associated with the parcel.7.3.2
result.bookstringA reference to the physical location of parcel information in the County Assessor's office.7.3.2
result.censusTractstringThe unique number assigned by the Census Bureau that identifies the tract to which this parcel belongs.7.3.2
result.councilDistrictstringThe council district to which the parcel belongs.7.3.2
result.exemptionValuedoubleThe total value of any tax exemptions that apply to the land within the parcel. 7.3.2
result.gisSequenceNumberlongThis is the ID number that you use to identify the parcel in Geographic Information Systems (GIS).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.improvedValuedoubleThis is the total value of any improvements to the land within the parcel.7.3.2
result.isPrimarystringIndicates whether or not to designate the parcel as the primary parcel.7.3.2
result.landValuedoubleThis is the total value of the land within the parcel.7.3.2
result.legalDescriptionstringThe legal description of the parcel.7.3.2
result.lotstringThis is the lot name.7.3.2
result.mapNumberstringThe unique map number that identifies the map for this parcel.7.3.2
result.mapReferenceInfostringThe 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.addressresult.owners.address{}The address of the subject.7.3.2
result.owners.address.addressLine1stringThe first line of the address. 7.3.2
result.owners.address.addressLine2stringThe second line of the address.7.3.2
result.owners.address.addressLine3stringThe third line of the address.7.3.2
result.owners.address.citystringThe name of the city.7.3.2
result.owners.address.countryresult.owners.address.country{}The name of the country.7.3.2
result.owners.address.country.textstringThe localized display text.7.3.2
result.owners.address.country.valuestringThe value for the specified parameter.7.3.2
result.owners.address.postalCodestringThe postal ZIP code for the address.7.3.2
result.owners.address.stateresult.owners.address.state{}The state corresponding to the address on record.7.3.2
result.owners.address.state.textstringThe localized display text.7.3.2
result.owners.address.state.valuestringThe value for the specified parameter.7.3.2
result.owners.emailstringThe contact's email address.7.3.2
result.owners.faxstringThe fax number for the contact.7.3.2
result.owners.firstNamestringThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
result.owners.fullNamestringThe contact's full name. This field is only active when the Contact Type selected is Individual.7.3.2
result.owners.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.owners.isPrimarystringIndicates whether or not to designate the owner as the primary owner.7.3.2
result.owners.lastNamestringThe last name (surname). 7.3.2
result.owners.mailAddressresult.owners.mailAddress{}Contains the fields that define an owner's address.7.3.2
result.owners.mailAddress.addressLine1stringThe first line of the address. 7.3.2
result.owners.mailAddress.addressLine2stringThe second line of the address.7.3.2
result.owners.mailAddress.addressLine3stringThe third line of the address.7.3.2
result.owners.mailAddress.citystringThe name of the city.7.3.2
result.owners.mailAddress.countryresult.owners.mailAddress.country{}The name of the country.7.3.2
result.owners.mailAddress.country.textstringThe localized display text.7.3.2
result.owners.mailAddress.country.valuestringThe value for the specified parameter.7.3.2
result.owners.mailAddress.postalCodestringThe postal ZIP code for the address.7.3.2
result.owners.mailAddress.stateresult.owners.mailAddress.state{}The state corresponding to the address on record.7.3.2
result.owners.mailAddress.state.textstringThe localized display text.7.3.2
result.owners.mailAddress.state.valuestringThe value for the specified parameter.7.3.2
result.owners.middleNamestringThe middle name. 7.3.2
result.owners.parcelIdstringThe unique Id generated for a parcel.7.3.2
result.owners.phonestringThe telephone number of the owner. 7.3.2
result.owners.phoneCountryCodestringThe country code for the assoicated phone number.7.3.2
result.owners.recordIdresult.owners.recordId{}The unique ID associated with a record.7.3.2
result.owners.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.owners.recordId.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.owners.recordId.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.owners.recordId.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
result.owners.recordId.valuestringThe value for the specified parameter.7.3.2
result.owners.statusresult.owners.status{}The owner status.7.3.2
result.owners.status.textstringThe localized display text.7.3.2
result.owners.status.valuestringThe value for the specified parameter.7.3.2
result.owners.structureNamestringThe name of the full or partial structure or establishment.7.3.2
result.owners.structureTypestringThe type of structure or establishment7.3.2
result.owners.taxIdstringThe owner's tax ID number.7.3.2
result.owners.titlestringThe individual's business title. 7.3.2
result.pagestringA reference to the physical location of the parcel information in the records of the County Assessor (or other responsible department).7.3.2
result.parcelstringThe official parcel name or number, as determined by the county assessor or other responsible department.7.3.2
result.parcelAreadoubleThe total area of the parcel. Your agency determines the standard unit of measure.7.3.2
result.parcelNumberstringThe localized display text.7.3.2
result.planAreastringThe total area of the parcel. Your agency determines the standard unit of measure.7.3.2
result.rangestringWhen 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.sectionlongA piece of a township measuring 640 acres, one square mile, numbered with reference to the base line and meridian line.7.3.2
result.statusresult.status{}The parcel 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.subdivisionresult.subdivision{}The name of the subdivision. 7.3.2
result.subdivision.textstringThe localized display text.7.3.2
result.subdivision.valuestringThe value for the specified parameter.7.3.2
result.supervisorDistrictstringThe supervisor district to which the parcel belongs.7.3.2
result.townshipstringWhen 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.tractstringThe name of the tract associated with this application. A tract may contain one or more related parcels.7.3.2
statusintegerThe 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
  }
}