Response Body Params:

Param NameDescription
status_codeDenotes the status of the response. Detailed guide can be found here
descriptionStates the description of the status_code. Gives you information about the success/error
responseContains details of the current resource fetched/updated/created

📘

Note

This endpoint is paginated response and retrieves 10 records at a time. To access any page you can append page as a query param to the URL

Users List OBJECT:

Param NameData TypeDescription
usersARRAY - User List ViewContains an array of User List View object

User List View OBJECT:

Param NameData TypeDescription
idintegerUnique identifier of a user
created_atdatetime - UTC formatDatetime when the user was created on the application
created_atdatetime - UTC formatDatetime when the user was last updated on the application
first_namestringFirst name of the user
last_namestringLast name of the user
login_idstringLogin ID of the user
email_idstringEmail ID of the user
statusenumCurrent status of the user:

- active

- inactive
accepting_chatsbooleanStates whether the user is ready to accept chats currently
active_chatsintegerNo. of chats being handled by the user in his/her My Chats currently

Response Codes

status_codeHTTP StatusDescription
4307200The list of users retrieved successfully
2002400Invalid header param - could not find mandatory header parameters
2003400Invalid Access Token
2004401Access Token expired
2007500Internal Server Error
2010404Could not find details of team based on the teamid passed in the header
2099405Method not allowed
3115400Request is invalid
3106500The user details could not be retrieved
Language