Get Contact Details by ID

curl -i -X GET \
  'https://api.portal.io/public/people/1042?IncludeCounts=true' \
  -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'

import requests
from portal_auth import sign_request  # See authentication guide

url = "https://api.portal.io/public/people/1042?IncludeCounts=true"
timestamp = "Mon, 06 Apr 2026 00:22:19 GMT"
signature = sign_request("GET", url, "", timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY")

response = requests.get(url, headers={
    "Accept": "application/json",
    "X-MSS-API-APPID": "YOUR_APP_ID",
    "X-MSS-API-USERKEY": "YOUR_USER_KEY",
    "X-MSS-CUSTOM-DATE": timestamp,
    "X-MSS-SIGNATURE": signature
})
print(response.json())

const { signRequest } = require('./portalAuth'); // See authentication guide

const url = "https://api.portal.io/public/people/1042?IncludeCounts=true";
const timestamp = new Date().toUTCString();
const signature = signRequest("GET", url, "", timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY");

const response = await fetch(url, {
    headers: {
        "Accept": "application/json",
        "X-MSS-API-APPID": "YOUR_APP_ID",
        "X-MSS-API-USERKEY": "YOUR_USER_KEY",
        "X-MSS-CUSTOM-DATE": timestamp,
        "X-MSS-SIGNATURE": signature
    }
});
const data = await response.json();
console.log(data);

{
  "notes": "Preferred contact via email.",
  "lastModifiedDate": "2026-04-06T00:22:19Z",
  "primaryLocation": {
    "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"
  },
  "billingLocation": null,
  "proposalCount": 4,
  "paymentCount": 2,
  "id": 1042,
  "partyType": "Person",
  "contactType": "Client",
  "firstName": "Jane",
  "lastName": "Smith",
  "companyName": "",
  "contactEmail": "jane.smith@example.com",
  "contactEmailCC": "",
  "contactPhone": "555-555-0100"
}

GET

public

people

{PersonId}

curl -i -X GET \
  'https://api.portal.io/public/people/1042?IncludeCounts=true' \
  -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'

import requests
from portal_auth import sign_request  # See authentication guide

url = "https://api.portal.io/public/people/1042?IncludeCounts=true"
timestamp = "Mon, 06 Apr 2026 00:22:19 GMT"
signature = sign_request("GET", url, "", timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY")

response = requests.get(url, headers={
    "Accept": "application/json",
    "X-MSS-API-APPID": "YOUR_APP_ID",
    "X-MSS-API-USERKEY": "YOUR_USER_KEY",
    "X-MSS-CUSTOM-DATE": timestamp,
    "X-MSS-SIGNATURE": signature
})
print(response.json())

const { signRequest } = require('./portalAuth'); // See authentication guide

const url = "https://api.portal.io/public/people/1042?IncludeCounts=true";
const timestamp = new Date().toUTCString();
const signature = signRequest("GET", url, "", timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY");

const response = await fetch(url, {
    headers: {
        "Accept": "application/json",
        "X-MSS-API-APPID": "YOUR_APP_ID",
        "X-MSS-API-USERKEY": "YOUR_USER_KEY",
        "X-MSS-CUSTOM-DATE": timestamp,
        "X-MSS-SIGNATURE": signature
    }
});
const data = await response.json();
console.log(data);

{
  "notes": "Preferred contact via email.",
  "lastModifiedDate": "2026-04-06T00:22:19Z",
  "primaryLocation": {
    "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"
  },
  "billingLocation": null,
  "proposalCount": 4,
  "paymentCount": 2,
  "id": 1042,
  "partyType": "Person",
  "contactType": "Client",
  "firstName": "Jane",
  "lastName": "Smith",
  "companyName": "",
  "contactEmail": "jane.smith@example.com",
  "contactEmailCC": "",
  "contactPhone": "555-555-0100"
}

Retrieve the full record for a single contact by their numeric ID. The response always includes primaryLocation and billingLocation when they exist. Pass IncludeCounts=true to also receive the number of proposals and payments associated with the contact — useful for dashboards and sync logic.

curl -i -X GET \
  'https://api.portal.io/public/people/1042?IncludeCounts=true' \
  -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'

import requests
from portal_auth import sign_request  # See authentication guide

url = "https://api.portal.io/public/people/1042?IncludeCounts=true"
timestamp = "Mon, 06 Apr 2026 00:22:19 GMT"
signature = sign_request("GET", url, "", timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY")

response = requests.get(url, headers={
    "Accept": "application/json",
    "X-MSS-API-APPID": "YOUR_APP_ID",
    "X-MSS-API-USERKEY": "YOUR_USER_KEY",
    "X-MSS-CUSTOM-DATE": timestamp,
    "X-MSS-SIGNATURE": signature
})
print(response.json())

const { signRequest } = require('./portalAuth'); // See authentication guide

const url = "https://api.portal.io/public/people/1042?IncludeCounts=true";
const timestamp = new Date().toUTCString();
const signature = signRequest("GET", url, "", timestamp, "YOUR_USER_KEY", "YOUR_SECRET_KEY");

const response = await fetch(url, {
    headers: {
        "Accept": "application/json",
        "X-MSS-API-APPID": "YOUR_APP_ID",
        "X-MSS-API-USERKEY": "YOUR_USER_KEY",
        "X-MSS-CUSTOM-DATE": timestamp,
        "X-MSS-SIGNATURE": signature
    }
});
const data = await response.json();
console.log(data);

{
  "notes": "Preferred contact via email.",
  "lastModifiedDate": "2026-04-06T00:22:19Z",
  "primaryLocation": {
    "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"
  },
  "billingLocation": null,
  "proposalCount": 4,
  "paymentCount": 2,
  "id": 1042,
  "partyType": "Person",
  "contactType": "Client",
  "firstName": "Jane",
  "lastName": "Smith",
  "companyName": "",
  "contactEmail": "jane.smith@example.com",
  "contactEmailCC": "",
  "contactPhone": "555-555-0100"
}

Authorizations

X-MSS-API-APPID

string

header

required

Portal application identifier used as part of HMAC-authenticated API requests.

X-MSS-API-USERKEY

string

header

required

Portal user API key used together with the HMAC signature headers.

X-MSS-CUSTOM-DATE

string

header

required

Timestamp header included in the signed request to prevent replay attacks.

X-MSS-SIGNATURE

string

header

required

HMAC-SHA256 signature for the request, calculated over the canonical string defined in the authentication docs.

Headers

enum<string>

required

Accept Header

Available options:

application/json

Path Parameters

PersonId

null | integer<int32>

required

Person Id.

Query Parameters

IncludeCounts

boolean

Response

Success

Contact detail model

integer<int32>

required

Unique numeric identifier of the contact

lastModifiedDate

string<date-time>

required

UTC timestamp when the contact was last modified

partyType

enum<string>

Available options:

Undefined,

Person,

Company

contactType

enum<string>

Available options:

Undefined,

Client,

Employee,

Contractor,

Other

firstName

string

Contact first name

lastName

string

Contact last name

companyName

string

Company name when the contact represents a company

contactEmail

string

Primary contact email address

contactEmailCC

string

Additional email addresses copied when a proposal is submitted

contactPhone

string

Primary contact phone number

notes

string

Free-text notes stored on the contact

primaryLocation

PublicContactLocationModel · object

Contact-location detail model

Show child attributes

billingLocation

PublicContactLocationModel · object

Contact-location detail model

Show child attributes

proposalCount

integer<int32>

Number of proposals linked to the contact when counts are requested

paymentCount

integer<int32>

Number of payments linked to the contact when counts are requested

⌘I

Authentication

Proposals

Proposal Items

Change Orders

AI Builder

People

Catalog

Users

Webhooks

Zapier Triggers

Get Contact Details by ID

Authorizations

Headers

Path Parameters

Query Parameters

Response