Get All Addresses

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

Resource Information

Scope	addresses Deprecated scope name: get_addresses
App Type	All
Authorization Type	No 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 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
country	string	No	Get All Address Countries	The name of the country.	7.3.2
direction	string	No	Get All Address Street Directions	The street direction of the primary address associated with the application.	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
id	string	No	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	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
offset	long	No	�	Indicates the offset start of each page by the number specified.	7.3.2
state	string	No	Get All Address States	The state corresponding to the address on record.	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
streetSuffix	string	No	Get All Address Street Suffixes	The type of street such as "Lane" or "Boulevard".	7.3.2
streetSuffixDirection	string	No	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
type	string	No	�	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

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.2
result.addressLine1	string	The first line of the address.	7.3.2
result.addressLine2	string	The second line of the address.	7.3.2
result.addressTypeFlag	result.addressTypeFlag{}	The status of the address record indicating whether the address is active or inactive.	7.3.2
result.addressTypeFlag.text	string	The localized display text.	7.3.2
result.addressTypeFlag.value	string	The value for the specified parameter.	7.3.2
result.auditStatus	string	The status of this address record.	7.3.2
result.city	string	The name of the city.	7.3.2
result.country	result.country{}	The name of the country.	7.3.2
result.country.text	string	The localized display text.	7.3.2
result.country.value	string	The value for the specified parameter.	7.3.2
result.county	string	The name of the county.	7.3.2
result.description	string	The description of the record or item.	7.3.2
result.direction	result.direction{}	The street direction of the primary address associated with the application.	7.3.2
result.direction.text	string	The localized display text.	7.3.2
result.direction.value	string	The value for the specified parameter.	7.3.2
result.distance	double	The distance from another landmark used to locate the address.	7.3.2
result.houseAlphaEnd	string	The ending street number that makes up the address.	7.3.2
result.houseAlphaStart	string	The beginning street number that makes up the address.	7.3.2
result.houseFractionEnd	result.houseFractionEnd{}	Used in combination with the Street # fields.	7.3.2
result.houseFractionEnd.text	string	The localized display text.	7.3.2
result.houseFractionEnd.value	string	The value for the specified parameter.	7.3.2
result.houseFractionStart	result.houseFractionStart{}	Used In combination with the Street # fields.	7.3.2
result.houseFractionStart.text	string	The localized display text.	7.3.2
result.houseFractionStart.value	string	The value for the specified parameter.	7.3.2
result.houseNumberEndFrom	long	The first of the ending house number range.	7.3.2
result.houseNumberEndTo	long	The last of the ending house number range.	7.3.2
result.houseNumberStartFrom	long	The first of the start house number range.	7.3.2
result.houseNumberStartTo	long	The last of the start house number range.	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.inspectionDistrict	string	The inspection district where the address is located.	7.3.2
result.inspectionDistrictPrefix	string	The prefix for the inspection district where the address is located.	7.3.2
result.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.levelEnd	string	The ending level number (floor number) that makes up the address within a complex.	7.3.2
result.levelPrefix	string	The prefix for the level numbers (floor numbers) that make up the address.	7.3.2
result.levelStart	string	The beginning level number (floor number) that makes up the address within a complex.	7.3.2
result.neighborhood	string	The neighborhood where the address is located.	7.3.2
result.neighborhoodPrefix	string	The prefix for the neighborhood where the address is located.	7.3.2
result.postalCode	string	The postal ZIP code for the address.	7.3.2
result.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.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.sourceFlag	string	The Accela permitting system that stores this address information.	7.3.2
result.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.state	result.state{}	The state corresponding to the address on record.	7.3.2
result.state.text	string	The localized display text.	7.3.2
result.state.value	string	The value for the specified parameter.	7.3.2
result.status	result.status{}	The address status indicating whether the address is active or inactive.	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.streetAddress	string	The street address.	7.3.2
result.streetEnd	long	The end of a range of street numbers.	7.3.2
result.streetName	string	The street name for the address.	7.3.2
result.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.streetStart	long	The start of a range of street numbers.	7.3.2
result.streetSuffix	result.streetSuffix{}	The type of street such as "Lane" or "Boulevard".	7.3.2
result.streetSuffix.text	string	The localized display text.	7.3.2
result.streetSuffix.value	string	The value for the specified parameter.	7.3.2
result.streetSuffixDirection	result.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.text	string	The localized display text.	7.3.2
result.streetSuffixDirection.value	string	The value for the specified parameter.	7.3.2
result.unitEnd	string	The end parameter of a range of unit numbers.	7.3.2
result.unitStart	string	The starting parameter of a range of unit numbers.	7.3.2
result.unitType	result.unitType{}	The unit type designation of the address.	7.3.2
result.unitType.text	string	The localized display text.	7.3.2
result.unitType.value	string	The value for the specified parameter.	7.3.2
result.xCoordinate	double	The longitudinal coordinate for this address.	7.3.2
result.yCoordinate	double	The latitudinal coordinate for this address.	7.3.2
status	integer	The 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
  }
}