Skip to main content
GET
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.

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

Accept
enum<string>
required

Accept Header

Available options:
application/json

Query Parameters

SearchText
null | string

Search text

ContactTypes
enum<string>[]

Contact Types.

Available options:
Person,
Company
SortBy
enum<string>
Available options:
ModifiedDate,
CreatedDate,
FirstName,
LastName,
LastActive,
LastActiveByMe
SortDirection
enum<string>
Available options:
Asc,
Desc
PageNumber
integer<int32>

Page number. Starting from 1

PageSize
integer<int32>

Page Size

Response

Success

Contact list response

people
PublicContactModel · object[]
required

Contacts returned for the current page

peopleCount
integer<int32>
required

Total number of contacts matching the current filter set