Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.portal.io/llms.txt

Use this file to discover all available pages before exploring further.

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.

​
Request

GET /public/users

​
Headers

​
Accept
string
required
Must be application/json.
​
X-MSS-API-APPID
string
required
Your API Application Key.
​
X-MSS-API-USERKEY
string
required
Your User API Key.
​
X-MSS-CUSTOM-DATE
string
required
Current UTC timestamp in RFC 7231 format (e.g. Mon, 06 Apr 2026 00:22:19 GMT).
​
X-MSS-SIGNATURE
string
required
HMAC-SHA256 signature of the canonical request, Base64-encoded.

​
Response

​
200 Success

​
users
array
required
Array of active user objects for the authenticated dealer account.
​
usersCount
integer
required
Total number of active users returned.

​
Error Codes

CodeMeaning
401Not authorized. Ensure valid HMAC authentication headers are provided.
403Your user account does not have permission for this action.
404No resource found with the given ID.

​
Example

curl -i -X GET \
  'https://api.portal.io/public/users' \
  -H 'Accept: application/json' \
  -H 'X-MSS-API-APPID: YOUR_APP_ID' \
  -H 'X-MSS-API-USERKEY: YOUR_USER_KEY' \
  -H 'X-MSS-CUSTOM-DATE: Mon, 06 Apr 2026 00:22:19 GMT' \
  -H 'X-MSS-SIGNATURE: BASE64_SIGNATURE'

{
  "users": [
    {
      "id": 77,
      "firstName": "Alex",
      "lastName": "Johnson",
      "email": "alex.johnson@dealership.com",
      "permissionGroup": "Sales"
    },
    {
      "id": 78,
      "firstName": "Maria",
      "lastName": "Torres",
      "email": "maria.torres@dealership.com",
      "permissionGroup": "Admin"
    }
  ],
  "usersCount": 2
}