We've launched a new documentation site. Visit docs.portal.io for the latest version.

Users

The Users service returns the users that belong to the authenticated dealer account.

Use these endpoints to discover the users who can be referenced by other public workflows.

Get User List

Returns a list of all active users within the authenticated caller's account. The response includes basic, non-sensitive user details: user ID, first name, last name, email address, and the user's permission group. This is a read-only endpoint intended for integrations that need to look up user IDs before assigning them as salespersons on proposals or for syncing user data with external systems.

Request
header Parameters
Accept
required
string

Accept Header

Value: "application/json"
X-MSS-API-APPID
required
string

Application Id

X-MSS-CUSTOM-DATE
required
string

A date timestamp of the request

X-MSS-SIGNATURE
required
string

A signature for the request

X-MSS-API-USERKEY
required
string

User API Key

Responses
200

Success

Response Schema: application/json
required
Array of objects (PublicUserModel)

Users returned for the authenticated account

usersCount
required
integer <int32>

Total number of users returned in the list

401

Not Authorized. Ensure a valid session cookie or HMAC authentication headers are provided.

403

You do not have permission for this action.

404

No resource exists with the given ID.

get/public/users
Request samples
Response samples
application/json
{
  • "users": [
    ],
  • "usersCount": 0
}