Get All Agents

Description : To fetch all agents in FAVEO

12. URL : api/v1/helpdesk/agents

Parameters :

Name	Data Type	Required/Optional	Description
token	String	Required	token generated for a user
api_key	String	Optional	An alphanumeric code that can be used to authenticate your API calls

HTTP Method : GET

Response Format : JSON

Response : Returns the list of agents in FAVEO

http://www.stablehelpdeskc.faveodemo.com/api/v1/helpdesk/agents?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9wcm9kdWN0ZGVtb3VybC5jb21cL2NvbW11bml0eVwvcHVibGljXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE1MzUwMTEwNjUsImV4cCI6MTUzNTAxMTMwNSwibmJmIjoxNTM1MDExMDY1LCJqdGkiOiJIdmU4djVTRkJCdm9QS3FEIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIn0._nOncp3_lhk-BaLk1to4bcBTeNoutXdTnL7sdoyvk_0

JSON Response Example :

Success Response :

{
    "result": [
        {
            "id": 1,
            "user_name": "demoadmin",
            "first_name": "Demo",
            "last_name": "Admin",
            "gender": 0,
            "email": "mr.dmartin1984@gmail.com",
            "ban": 0,
            "active": 1,
            "is_delete": 0,
            "ext": "",
            "country_code": 0,
            "phone_number": "",
            "mobile": null,
            "agent_sign": "",
            "account_type": "",
            "account_status": "",
            "assign_group": 1,
            "primary_dpt": 1,
            "agent_tzone": "",
            "daylight_save": "",
            "limit_access": "",
            "directory_listing": "",
            "vacation_mode": "",
            "company": "",
            "role": "admin",
            "internal_note": "",
            "profile_pic": "https://secure.gravatar.com/avatar/b4bfa60e2b38b40cf980d30da5f6373b?s=80&r=g&d=identicon",
            "created_at": "2018-08-13 14:22:49",
            "updated_at": "2018-08-13 14:23:14",
            "user_language": null
        }
    ]
}

Some Common Error :

Error Response : If the token is expired

{
“error":"Token has expired"
}

If the token is not provided

 {
  "error": "token_not_provided"
}

Response Description :

Parameter	Description
id	id of the agent
user_name	user name of the agent
first_name	first name of the agent
last_name	first name of the agent
gender	gender of the agent
email	email of the agent
ban	if the agent is banned or not
active	if the agent is active or not
is_delete	if the agent is deleted or not
ext	extension of the agent phone number
country_code	country code of the agent mobile number
phone_number	agent phone number
mobile	agent mobile number
agent_sign	first name of the user
account_status	agent account status
assign_group	agent assigned group
primary_dpt	agent primary department
agent_tzone	agent time zone
daylight_save	first name of the user
limit_access	first name of the user
directory_listing	first name of the user
vacation_mode	first name of the user
company	company name of the agent
role	role of the agent
internal_note	first name of the user
created_at	creation date of the agent
updated_at	*agent profile updated date *
user_language	language of the agent