Retrieve an address

Retrieves an address, based on a given address ID.

SecurityCommonAuth
Request
path Parameters
addressId
required
string <uuid>

The ID of the address to work with.

Example: 5973c3bc-70f4-48d6-92d5-4007f484b76c
query Parameters
accountId
required
string (accountId)

The ID of the account to work with.

Example: accountId=F50091
Responses
200

OK

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

get/addresses/{addressId}
Request samples 
Response samples 
application/json
{
  • "id": "55ddc56e-f605-49c6-9862-0e8b55fa368f",
  • "type": "office",
  • "nickName": "office",
  • "addressLine1": "Great Building",
  • "addressLine2": "Four Maple Street",
  • "addressLine3": "Southwark",
  • "addressContact": "Brian May",
  • "city": "London",
  • "postcode": "SE13UB",
  • "country": "England"
}