Skip to main content
GET
Returns a list of all active users in your Portal.io dealer account. The response contains basic, non-sensitive information: user ID, first name, last name, email address, and the user’s permission group. This is a read-only endpoint designed for integrations that need to discover user IDs before assigning them as salespersons on proposals, or for syncing user data with external CRM and ERP systems.
The id field from each user in this response is the SalesPersonId you supply when creating or updating proposals via the API.

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

Response

Success

User list response

users
PublicUserModel · object[]
required

Users returned for the authenticated account

usersCount
integer<int32>
required

Total number of users returned in the list