get https://examplebaseURL.com/v1/api/apps//contacts/staffcontact-list
Response Format
Parameter | Type | Description |
---|---|---|
id | String | Staff unique id |
status | String | The status of the staff account in CINNOX: - Activated - account created and actively in use - Not activated - account created, but the email address is not validated, and no password has been set yet - Suspended - account created, activated but disabled |
firstName | String | Staff first name |
lastName | String | Staff last name |
String | Staff email address | |
phone | Number | Staff contact number |
role | String | The assigned role to the staff |
dataScope | String | Data Access Level assigned to the staff |
jobTitle | String | Staff job title |
timezone | String | Staff time zone |
extensionNumber | Number | Staff extension number |
avatarUrl | String | The URL of the staff profile image / avatar |
displayName | String | The staff displayed name to the visitors |
twoFactorAuthentication | Boolean | True: required to use two-factor authentication to sign in to CINNOX. False: no two-factor authentication is required to sign in to CINNOX. |
microsoftActiveDirectory | Boolean | True: allowed to sign in to the CINNOX service using the Microsoft Active Directory Federation Services (AD FS) as the Third-Party Authentication False: not allowed to sign in to the CINNOX service using the Microsoft Active Directory Federation Services (AD FS) as the Third-Party Authentication. |
directStaffEnquiry | Boolean | True: can be directly contacted by the website visitor False: cannot be directly contacted by the website visitor |
directchatEnquiry | String | The URL for visitors to make a direct chat enquiry to the staff |
directCallEnquiry | String | The URL for visitors to make a direct call enquiry to the staff |