Retrieves all addresses stored for a specific contact. Results are ordered with the primary location first, the billing location second, and then the remaining locations sorted by most recently modified. Pagination defaults to page 1 with 10 results per page. PageNumber must be 1 or greater — values less than 1 return a 400 error.
Request GET /public/people/{ContactId}/locationMust be application/json.
Your API Application Key.
Current UTC timestamp in RFC 7231 format (e.g. Mon, 06 Apr 2026 00:22:19 GMT).
HMAC-SHA256 signature of the canonical request, Base64-encoded.
Path Parameters Unique numeric identifier of the contact whose locations to retrieve.
Query Parameters 1-based page index. Defaults to 1. Must be 1 or greater — values less than 1 return a 400 error.
Number of locations per page. Defaults to 10.
Response 200 Success Ordered array of location objects for the contact. Unique numeric identifier of the location.
Suite, unit, or apartment number.
Full state or province name.
Two-letter state or province abbreviation.
Phone number for this location.
First name of the on-site contact for this address.
Last name of the on-site contact for this address.
Phone number of the on-site contact.
Email address of the on-site contact.
true if this is the contact’s primary location.
true if this is the contact’s billing location.
Total number of locations for this contact (across all pages).
Error Codes Code Meaning 401 Not authorized. Your HMAC signature was incorrect or credentials are invalid. 403 Your user account does not have permission for this API call.
Example curl -i -X GET \ 'https://api.portal.io/public/people/1042/location?PageNumber=1&PageSize=10' \ -H 'Accept: application/json' \ -H 'X-MSS-API-APPID: YOUR_APP_ID' \ -H 'X-MSS-API-USERKEY: YOUR_USER_KEY' \ -H 'X-MSS-CUSTOM-DATE: Mon, 06 Apr 2026 00:22:19 GMT' \ -H 'X-MSS-SIGNATURE: BASE64_SIGNATURE'
{ "contactLocations" : [ { "contactFirstName" : "Jane" , "contactLastName" : "Smith" , "contactPhoneNumber" : "555-555-0100" , "contactEmail" : "jane.smith@example.com" , "isPrimary" : true , "isBilling" : false , "id" : 201 , "street" : "123 Main St" , "suite" : "" , "city" : "Austin" , "postalCode" : "78701" , "state" : "Texas" , "stateAbbrev" : "TX" , "country" : "United States" , "phone" : "555-555-0100" } ], "locationCount" : 1 }
