GET

/address

Usage Notes

When

Retrieve address by AddressID or ExternalAddressId
Verify address details before correspondence or compliance updates
Access address data for cross-entity queries

Requirements

AddressID or ExternalAddressId to identify the record

Notes

Returns complete address data with entity ownership details
AddressID provides faster lookup than ExternalAddressId
Each address links to exactly one entity type (BizEntity, Person, or Organisation)

Description

Retrieves an address record with all location fields and entity association. Supports lookup by native AddressID or ExternalAddressId.

Required Headers

See Authentication for obtaining access tokens.

Header	Value	Description
`Authorization`	`{accessToken}`	JWT token for API access
`Version`	`2.0`	API version identifier

Query Parameters

Parameter	Type	Required	Description
`AddressID` >	integer	> Conditional...	The unique system identifier for the address record. Provide this to retrieve a specific address by its internal ID.
`ExternalAddressId` >	string	> Conditional...	The external system identifier for the address record. Use this when integrating with external systems that maintain their own ID references.

AddressID

integer

> Conditional...

The unique system identifier for the address record. Provide this to retrieve a specific address by its internal ID.

ExternalAddressId

string

> Conditional...

The external system identifier for the address record. Use this when integrating with external systems that maintain their own ID references.

Example Requests

bash

# Get address by internal ID
curl -X GET "https://api.7g.com.au/address?AddressID=7001" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Get address by external ID
curl -X GET "https://api.7g.com.au/address?ExternalAddressId=EXT-ADDR-001" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

Response Examples

json

{
  "result": true,
  "message": "",
  "recordCount": 1,
  "data": {
    "addressID": 7001,
    "externalAddressId": "EXT-ADDR-001",
    "addressTypeID": 1,
    "aboveAddressLine": "Unit 5",
    "addressLine": "123 Collins Street",
    "suburb": "Melbourne",
    "postcode": "3000",
    "stateCode": "VIC",
    "countryCode": "AUS",
    "bizEntityID": 12345,
    "externalBizEntityId": "EXT-BIZ-001",
    "personID": null,
    "externalPersonId": null,
    "organisationID": null,
    "externalOrganisationId": null
  }
}