Get All Addresses

Gets the addresses available in the system. Specify at least one filter criteria.

Resource Information

Scopeaddresses

Deprecated scope name:   get_addresses

App TypeAll
Authorization TypeNo authorization required
URI /v4/addresses?lang={lang}&id={id}&type={type}&isPrimary={isPrimary}&streetName={streetName}&streetStart={streetStart}&direction={direction}&streetSuffixDirection={streetSuffixDirection}&streetSuffix={streetSuffix}&city={city}&country={country}&state={state}&limit={limit}&offset={offset}&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
countrystringNo Get All Address Countries The name of the country.7.3.2
directionstringNo Get All Address Street Directions The street direction of the primary address associated with the application.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
idstringNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.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
offsetlongNo Indicates the offset start of each page by the number specified.7.3.2
statestringNo Get All Address States The state corresponding to the address on record.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
streetSuffixstringNo Get All Address Street Suffixes The type of street such as "Lane" or "Boulevard".7.3.2
streetSuffixDirectionstringNo Get All Address Street Directions 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
typestringNo The type of entity to be queried.7.3.2

Example

Sample Request Head

https://apis.accela.com/v4/addresses

Sample Request Body

{
  "state": "CA",
  "limit": "Tester"
}

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.addressLine1stringThe first line of the address. 7.3.2
result.addressLine2stringThe second line of the address.7.3.2
result.addressTypeFlagresult.addressTypeFlag{}The status of the address record indicating whether the address is active or inactive.7.3.2
result.addressTypeFlag.textstringThe localized display text.7.3.2
result.addressTypeFlag.valuestringThe value for the specified parameter.7.3.2
result.auditStatusstringThe status of this address record.7.3.2
result.citystringThe name of the city.7.3.2
result.countryresult.country{}The name of the country.7.3.2
result.country.textstringThe localized display text.7.3.2
result.country.valuestringThe value for the specified parameter.7.3.2
result.countystringThe name of the county.7.3.2
result.descriptionstringThe description of the record or item.7.3.2
result.directionresult.direction{}The street direction of the primary address associated with the application.7.3.2
result.direction.textstringThe localized display text.7.3.2
result.direction.valuestringThe value for the specified parameter.7.3.2
result.distancedoubleThe distance from another landmark used to locate the address. 7.3.2
result.houseAlphaEndstringThe ending street number that makes up the address.7.3.2
result.houseAlphaStartstringThe beginning street number that makes up the address.7.3.2
result.houseFractionEndresult.houseFractionEnd{}Used in combination with the Street # fields.7.3.2
result.houseFractionEnd.textstringThe localized display text.7.3.2
result.houseFractionEnd.valuestringThe value for the specified parameter.7.3.2
result.houseFractionStartresult.houseFractionStart{}Used In combination with the Street # fields.7.3.2
result.houseFractionStart.textstringThe localized display text.7.3.2
result.houseFractionStart.valuestringThe value for the specified parameter.7.3.2
result.houseNumberEndFromlongThe first of the ending house number range. 7.3.2
result.houseNumberEndTolongThe last of the ending house number range. 7.3.2
result.houseNumberStartFromlongThe first of the start house number range. 7.3.2
result.houseNumberStartTolongThe last of the start house number range. 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.inspectionDistrictstringThe inspection district where the address is located.7.3.2
result.inspectionDistrictPrefixstringThe prefix for the inspection district where the address is located.7.3.2
result.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.levelEndstringThe ending level number (floor number) that makes up the address within a complex.7.3.2
result.levelPrefixstringThe prefix for the level numbers (floor numbers) that make up the address.7.3.2
result.levelStartstringThe beginning level number (floor number) that makes up the address within a complex.7.3.2
result.neighborhoodstringThe neighborhood where the address is located.7.3.2
result.neighborhoodPrefixstringThe prefix for the neighborhood where the address is located.7.3.2
result.postalCodestringThe postal ZIP code for the address.7.3.2
result.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.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.sourceFlagstringThe Accela permitting system that stores this address information.7.3.2
result.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.stateresult.state{}The state corresponding to the address on record.7.3.2
result.state.textstringThe localized display text.7.3.2
result.state.valuestringThe value for the specified parameter.7.3.2
result.statusresult.status{}The address status indicating whether the address is active or inactive.7.3.2
result.status.textstringThe localized display text.7.3.2
result.status.valuestringThe value for the specified parameter.7.3.2
result.streetAddressstringThe street address. 7.3.2
result.streetEndlongThe end of a range of street numbers.7.3.2
result.streetNamestringThe street name for the address.7.3.2
result.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.streetStartlongThe start of a range of street numbers.7.3.2
result.streetSuffixresult.streetSuffix{}The type of street such as "Lane" or "Boulevard".7.3.2
result.streetSuffix.textstringThe localized display text.7.3.2
result.streetSuffix.valuestringThe value for the specified parameter.7.3.2
result.streetSuffixDirectionresult.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.streetSuffixDirection.textstringThe localized display text.7.3.2
result.streetSuffixDirection.valuestringThe value for the specified parameter.7.3.2
result.unitEndstringThe end parameter of a range of unit numbers.7.3.2
result.unitStartstringThe starting parameter of a range of unit numbers.7.3.2
result.unitTyperesult.unitType{}The unit type designation of the address.7.3.2
result.unitType.textstringThe localized display text.7.3.2
result.unitType.valuestringThe value for the specified parameter.7.3.2
result.xCoordinatedoubleThe longitudinal coordinate for this address. 7.3.2
result.yCoordinatedoubleThe latitudinal coordinate for this address. 7.3.2
statusintegerThe record status.7.3.3

Example

Sample Response Body

{
  "result": [
    {
      "city": "Pleasantville",
      "postalCode": "97777",
      "id": 2,
      "sourceNumber": 1,
      "auditStatus": "A",
      "isPrimary": "N",
      "streetName": "Main",
      "streetStart": 100,
      "country": {
        "value": "US",
        "text": "United States"
      },
      "state": {
        "value": "CA",
        "text": "CA"
      },
      "direction": {
        "value": "N",
        "text": "N"
      },
      "streetSuffix": {
        "value": "St",
        "text": "St"
      },
      "status": {
        "value": "A",
        "text": "Active"
      }
    },
    {
      "city": "San Ramon",
      "postalCode": "94583",
      "id": 24,
      "sourceNumber": 1,
      "auditStatus": "A",
      "isPrimary": "Y",
      "streetName": "Bishop",
      "streetStart": 2633,
      "country": {
        "value": "US",
        "text": "United States"
      },
      "state": {
        "value": "CA",
        "text": "CA"
      },
      "streetSuffix": {
        "value": "Dr",
        "text": "Dr"
      },
      "status": {
        "value": "A",
        "text": "Active"
      }
    }
  ],
  "status": 200,
  "page": {
    "offset": 0,
    "limit": 2,
    "hasmore": true
  }
}