Search and List Contacts in Your Account

GET /public/people — Returns a paged list of contacts. Filter by search text or contact type; sort results; defaults to page 1, size 10.

The People endpoint returns all contacts stored in your Portal.io dealer account. You can narrow results with a free-text search, filter by one or more contact types, control sort order, and paginate using PageNumber and PageSize. When either pagination value is missing or less than or equal to zero, the API defaults to page 1 with 10 results per page.

Request

GET /public/people

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.

Query Parameters

SearchText · string

Free-text string matched against contact names, company names, and email addresses.

ContactTypes · array

Filter by contact party type. Repeat the parameter for multiple values, e.g. ContactTypes=Person&ContactTypes=Company. Valid values: Person, Company. When omitted, all types are returned.

SortBy · string

Field to sort results by. One of ModifiedDate, CreatedDate, FirstName, LastName, LastActive, LastActiveByMe.

SortDirection · string

Sort direction. One of Asc or Desc. Defaults to Asc.

PageNumber · integer

1-based page index. Defaults to 1 when missing or less than 1.

PageSize · integer

Number of records per page. Defaults to 10 when missing or ≤ 0.

Response

200 Success

people · array · required

Array of contact objects matching the search criteria.

Show Contact object

id · integer

Unique numeric identifier of the contact.

partyType · string

Whether the contact is a Person or Company. Undefined if unset.

contactType · string

Classification of the contact. One of Client, Employee, Contractor, Other. Undefined if unset.

firstName · string

Contact’s first name.

lastName · string

Contact’s last name.

companyName · string

Company name. Populated when partyType is Company.

contactEmail · string

Primary email address.

contactEmailCC · string

CC email address for proposal delivery.

contactPhone · string

Primary phone number.

peopleCount · integer · required

Total number of contacts matching the query (across all pages).

Error Codes

Code	Meaning
401	Not authorized. Your HMAC signature was incorrect or credentials are invalid.
402	An active Portal.io subscription is required to use this endpoint.
403	Your user account does not have permission for this API call.

Example

curl

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

{
  "people": [
    {
      "id": 1042,
      "partyType": "Person",
      "contactType": "Client",
      "firstName": "Jane",
      "lastName": "Smith",
      "companyName": "",
      "contactEmail": "[e-mail]",
      "contactEmailCC": "",
      "contactPhone": "555-555-0100"
    }
  ],
  "peopleCount": 1
}