Table of Contents
An Intake User in Supportable represents an individual user account for the system. Intake Users are categorized into the Sub-Entities for which they work, and their permissions in the Supportable application are determined by the Role to which they are assigned. Standard users must have a Role assigned. Org Admin Users do not require permissions and have full access across all Sub-Entities, and therefore do not have a Role assigned.
Sample Request #
Headers | Authorization = Bearer [token] |
Parameters | None |
Body | None |
Get all Intake Users for Company #
GET https://connect.supportableapp.com/api/intake-users
Get individual Intake User #
GET https://connect.supportableapp.com/api/intake-users/{intakeUserId}
Sample Response JSON #
Status: 200
[ { "id": "631b7fccb85f7b84cd478b29", "userName": "demo@dashboardtraction.com", "firstName": "Demo", "middleName": "", "lastName": "Dan", "mobile": "5555555555", "businessPhoneNumber": null, "businessPhoneExtension": null, "position": null, "status": true, "subEntityId": "6398b8a6904c0725a6e560f2" }, . . . ]
Notes on Values #
Attribute | Data Type | Description |
---|---|---|
id | string | The unique identifier for the Intake User. |
username | string | The username with which the Intake User logs into the system. |
firstName | string | The first name of the Intake User. |
middleName | string | The middle name of the Intake User. |
lastName | string | The last name of the Intake User. |
mobile | string | The mobile phone number of the Intake User. |
businessPhoneNumber | string | The business phone number of the Intake User. |
businessPhoneExtension | string | The extension of the Intake User’s business phone number, if any. |
position | object | The position to which the Intake User belongs. |
position.id | string | The unique identifier of the position. |
position.name | string | The name of the position. |
position.status | string | Whether the position is active in Supportable. |
subEntityId | string | The unique identifier of the Sub-Entity to which the Intake User belongs. |