Sales Users Details
Revision as of 09:18, 21 July 2026 by Ashley DeBon (talk | contribs) (Created page with "== Get Users == === Base URL === https://apimobile.callproof.com === Endpoint === /api/users === Purpose === Retrieves the list of active users in the authenticated user’...")
Contents
Get Users
Base URL
https://apimobile.callproof.com
Endpoint
/api/users
Purpose
Retrieves the list of active users in the authenticated user’s company (non-disabled profiles). Useful for assigning sales reps and similar company-user selection screens.
HTTP Method
GET
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
None.
Query Parameters
None.
Request Body
None.
Successful Response (200)
Returns company users who are active and not disabled.
| Field | Type | Description |
|---|---|---|
| clientStatusCode | integer | Status indicator for the client (for example, 200) |
| user_id | integer | Identifier of the authenticated user |
| company_id | integer | Identifier of the authenticated user’s company |
| data | object | Users payload |
| uri | string | Requested resource URI |
data.users[]
| Field | Type | Description |
|---|---|---|
| id | integer | Unique identifier of the user |
| full_name | string | Full name (first name + last name) |
| username | string | Username |
| string | Email address |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – users could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while retrieving users (for example, "Error while retriving the Users List").
- 401 – Authentication failed or the access token is missing/expired.
