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.

Headers

Accept
enum<string>
required

Accept Header

Available options:
application/json
X-MSS-API-APPID
string
required

Application Id

X-MSS-CUSTOM-DATE
string
required

A date timestamp of the request

X-MSS-SIGNATURE
string
required

A signature for the request

X-MSS-API-USERKEY
string
required

User API Key

Query Parameters

SearchText
string

Search text

ContactTypes
enum<string>[]

Contact Types.

Available options:
Person,
Company
SortBy
enum<string>
Available options:
ModifiedDate,
CreatedDate,
FirstName,
LastName,
LastActive,
LastActiveByMe
SortDirection
string
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