List Locations for a Contact

GET /public/people//location — Returns paged locations for a contact, ordered: primary first, then billing, then most recently modified.

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}/location

Headers

Accept · string · required

Must be application/json.

X-MSS-API-APPID · string · required

Your API Application Key.

X-MSS-API-USERKEY · string · required

Your User API Key.

X-MSS-CUSTOM-DATE · string · required

Current UTC timestamp in RFC 7231 format (e.g. Mon, 06 Apr 2026 00:22:19 GMT).

X-MSS-SIGNATURE · string · required

HMAC-SHA256 signature of the canonical request, Base64-encoded.

Path Parameters

ContactId · integer · required

Unique numeric identifier of the contact whose locations to retrieve.

Query Parameters

PageNumber · integer

1-based page index. Defaults to 1. Must be 1 or greater — values less than 1 return a 400 error.

PageSize · integer

Number of locations per page. Defaults to 10.

Response

200 Success

contactLocations · array

Ordered array of location objects for the contact.

Show Location object

id · integer

Unique numeric identifier of the location.

street · string

Street address.

suite · string

Suite, unit, or apartment number.

city · string

City name.

postalCode · string

ZIP or postal code.

state · string

Full state or province name.

stateAbbrev · string

Two-letter state or province abbreviation.

country · string

Country name.

phone · string

Phone number for this location.

contactFirstName · string

First name of the on-site contact for this address.

contactLastName · string

Last name of the on-site contact for this address.

contactPhoneNumber · string

Phone number of the on-site contact.

contactEmail · string

Email address of the on-site contact.

isPrimary · boolean · required

true if this is the contact’s primary location.

isBilling · boolean · required

true if this is the contact’s billing location.

locationCount · integer · required

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

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'

200

{
  "contactLocations": [
    {
      "contactFirstName": "Jane",
      "contactLastName": "Smith",
      "contactPhoneNumber": "555-555-0100",
      "contactEmail": "[e-mail]",
      "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
}