Get the List of All the Operators
Description
This API can be used to get the list of all the operators of your firm.
Query Parameters
- last_sync_time - To retrieve the operators that are modified after the given time.
- index - As the operator list is limited to 20 per fetch, you can use this param to fetch the next set of operators.
Note: If not provided, then the index will be taken as 1.
status_code - Status code represents the operator availability status.
1 - Available
3 - Busy
OAuth Scope:
SalesIQ.operators.READ
URL
Copiedhttps://{[zohosalesiq_server_uri](https://www.zoho.com/salesiq/help/developer-section/rest-api-v2.html)}/api/v2/{screen name}/operators
Example
Copiedhttps://salesiq.zoho.com/api/v2/zylker-inc/operators
Success Response
Copied{
"url": "/api/v2/integtest/operators",
"object": "list",
"data": [
{
"is_chat_enabled": "true",
"first_name": "Patricia",
"is_enabled": "true",
"nick_name": "patty",
"wms_id": "LD_55158025_33290000000002001",
"email_id": "patricia@zylker.com",
"status_code": "1",
"status_message": "Available",
"notify": {
"new_visit": "true",
"return_visit": "true"
},
"zuid": "54715436",
"is_owner": "false",
"id": "33290000000002001",
"is_confirmed": "true",
"is_deleted": "false",
"last_name": "Boyle",
"maximum_concurrent_chat": "1",
"created_time": "1526039970065",
"modifed_time": "1535083323660",
"image_url": "/api/v2/zylker/downloads/1534838599109_33290000000002001?purpose=operator_image",
"role": "Administrator"
},
{
"is_chat_enabled": "true",
"first_name": "tricia",
"is_enabled": "true",
"nick_name": "tricy",
"wms_id": "LD_55158025_33290000000056013",
"email_id": "tricia@zylker.com",
"status_code": "1",
"status_message": "Available",
"notify": {
"new_visit": "true",
"return_visit": "true"
},
"zuid": "54716165",
"is_owner": "true",
"id": "33290000000056013",
"is_confirmed": "true",
"is_deleted": "false",
"last_name": "daniel",
"maximum_concurrent_chat": "0",
"created_time": "1527065158006",
"modifed_time": "1535449920367",
"image_url": "/api/v2/zylker/downloads/0_33290000000056013?purpose=operator_image",
"role": "Administrator"
},
{
"is_chat_enabled": "true",
"first_name": "Williams",
"is_enabled": "true",
"nick_name": "willi",
"wms_id": "LD_55158025_33290000000165001",
"email_id": "williams@zylker.com",
"status_code": "1",
"status_message": "Available",
"notify": {
"new_visit": "true",
"return_visit": "true"
},
"zuid": "54689562",
"is_owner": "false",
"id": "33290000000165001",
"is_confirmed": "true",
"is_deleted": "false",
"last_name": "Henry",
"maximum_concurrent_chat": "0",
"created_time": "1528105624852",
"modifed_time": "1533811728764",
"image_url": "/api/v2/zylker/downloads/0_33290000000165001?purpose=operator_image",
"role": "Administrator"
},
{
"is_chat_enabled": "true",
"first_name": "Dennis",
"is_enabled": "true",
"nick_name": "denny",
"wms_id": "LD_55158025_33290000000183001",
"email_id": "denny@zylker.com",
"status_code": "1",
"status_message": "Available",
"notify": {
"new_visit": "true",
"return_visit": "true"
},
"is_owner": "false",
"id": "33290000000183001",
"is_confirmed": "false",
"is_deleted": "true",
"last_name": "Blood",
"maximum_concurrent_chat": "0",
"created_time": "1528267062372",
"modifed_time": "1528434089014",
"image_url": "/api/v2/zylker/downloads/0_33290000000183001?purpose=operator_image",
"role": "Administrator"
},
{
"is_chat_enabled": "true",
"first_name": "Issac",
"is_enabled": "true",
"nick_name": "iccy",
"wms_id": "LD_55158025_33290000000183005",
"email_id": "issac@zylker.com",
"status_code": "1",
"status_message": "Available",
"notify": {
"new_visit": "true",
"return_visit": "true"
},
"is_owner": "false",
"id": "33290000000183005",
"is_confirmed": "false",
"is_deleted": "true",
"last_name": "James",
"maximum_concurrent_chat": "0",
"created_time": "1528267150314",
"modifed_time": "1528956595497",
"image_url": "/api/v2/zylker/downloads/0_33290000000183005?purpose=operator_image",
"role": "Associate"
},
{
"is_chat_enabled": "true",
"first_name": "Natalie",
"is_enabled": "true",
"nick_name": "natty",
"wms_id": "LD_55158025_33290000000184001",
"email_id": "f@gmai.fo",
"status_code": "1",
"status_message": "Available",
"notify": {
"new_visit": "true",
"return_visit": "true"
},
"is_owner": "false",
"id": "33290000000184001",
"is_confirmed": "false",
"is_deleted": "true",
"last_name": "Harry",
"maximum_concurrent_chat": "0",
"created_time": "1528268772011",
"modifed_time": "1528434081880",
"image_url": "/api/v2/zylker/downloads/0_33290000000184001?purpose=operator_image",
"role": "Associate"
}
],
"sync_time": "1535523611563"
}