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.

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

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