/Addresses
  • 18 Jan 2024
  • 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

Success

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

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.