Sign in

v1

latestOpenAPI 3.1.02026-07-136388308.2 KB
Profile Management

Get the address of a user

This endpoint will return the address of a specific Fire user. You will need to enable PERM_BUSINESS_GET_USER_ADDRESS to use this endpoint.

get/v2/users/{userId}/address

Path parameters

userIdinteger required

Lists a specific User

Example:14059

Response

A user's address

type'HOME' | 'BUSINESS'

The type of address this is for the user

address1string

This is the 1st line of the address

citystring

This is the city listed for the address

postcodestring

This is the postcode listed for the address

Example response

{
  "address1": "1, Road 1",
  "city": "Dublin",
  "country": {
    "code": "GB",
    "description": "United Kingdom"
  },
  "postcode": "D01 E100"
}