/Addresses
  • 16 Dec 2024
  • 13 Minutes to read
  • PDF

/Addresses

  • PDF

Article summary

Get
/Addresses

Retrieve street address information from Aspire records. 

Security
HTTP
Type bearer

Bearer Authorization Token

Query parameters
$select
string
$filter
string
$expand
string
$orderby
string
$skip
string
$top
string
$pageNumber
string
$limit
string
Responses
200

OK

Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null
Array of object
object
AddressID
integer (int32)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
CreatedByUserId
integer (int32) | null
CreatedByUserName
string | null
Min length0
Max length101
CreatedOn
string (date-time) | null
LastModifiedByUserId
integer (int32) | null
LastModifiedByUserName
string | null
Min length0
Max length101
LastModifiedOn
string (date-time) | null

Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.