ClientPortalUsers
This entity describes an Autotask Company Contact that has been assigned access to the Client Access Portal. In the Autotask Interface, Company Contacts are enabled as Client Portal Users in Admin > Client Access Portal > Manage Companies > select Company > "Manage users for this account" or from the Client Portal tab of the Edit Contact window.
NOTE You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.
Entity details
Entity Name: | ClientPortalUsers |
Entity Path: |
/atservicesrest/v1.0/ClientPortalUsers |
Can Create: |
![]() |
Can Update: |
![]() |
Can Query: |
![]() |
Can Delete: | |
Can Have UDFs: |
Fields that cannot be queried
The following fields from this entity will return an error when queried.
- Password
Conditions and requirements
Special field attributes
Field | Conditions and Requirements |
---|---|
contactID |
contactID cannot be modified once created. |
userName |
userName must be unique. |
securityLevel |
securityLevel refers to Client Access Portal security levels. |
password |
Required on create |
Field definitions
Field Name | Datatype | Read-Only | Is Required | Reference Name | Picklist |
---|---|---|---|---|---|
contactID | integer |
![]() |
![]() |
Contacts | |
dateFormat | integer |
![]() |
![]() |
||
id | long |
![]() |
![]() |
||
isClientPortalActive | boolean |
![]() |
|||
numberFormat | integer |
![]() |
![]() |
||
password | string (50) | ||||
securityLevel | integer |
![]() |
![]() |
||
timeFormat | integer |
![]() |
![]() |
||
userName | string (200) |
![]() |