Search Customers

Description : To fetch all customers registered in the System based on search criteria. Maximum 10 records per page can be retrieved.

14. 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
seacrh	String	Required	key word or letter to search the customer, name,email, first_name and las_name

HTTP Method : GET

Response Format : JSON

Response : Returns the list of customers in FAVEO based on the search criteria.

http://www.stablehelpdeskc.faveodemo.com/api/v1/helpdesk/customers?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9wcm9kdWN0ZGVtb3VybC5jb21cL2NvbW11bml0eVwvcHVibGljXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE1MzUwMTE2NzIsImV4cCI6MTUzNTAxMTkxMiwibmJmIjoxNTM1MDExNjcyLCJqdGkiOiI5Vklvc3VuVUpzTUFMOWRUIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIn0.djrBxAkq9hOW6odT6T8HnJuYoqVKLranKrnGHAQcm0Q&search=ganesh@kailash.com

JSON Response Example :

Success Response :

{
    "result": [
        {
            "id": 3,
            "user_name": "ganesh@kailash.com",
            "first_name": "Ganesh",
            "last_name": "",
            "gender": 0,
            "email": "ganesh@kailash.com",
            "ban": 0,
            "active": 1,
            "is_delete": 0,
            "ext": "",
            "country_code": 91,
            "phone_number": "",
            "mobile": "9158656569",
            "agent_sign": "",
            "account_type": "",
            "account_status": "",
            "assign_group": null,
            "primary_dpt": null,
            "agent_tzone": "",
            "daylight_save": "",
            "limit_access": "",
            "directory_listing": "",
            "vacation_mode": "",
            "company": "",
            "role": "user",
            "internal_note": "",
            "profile_pic": "https://secure.gravatar.com/avatar/4b34f7aab1601f396d2cc2c7cb6d3567?s=80&r=g&d=identicon",
            "created_at": "2018-08-14 06:21:43",
            "updated_at": "2018-08-14 06:21:43",
            "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 customer
user_name	user name of the customer
first_name	first name of the customer
last_name	first name of the customer
gender	gender of the customer
email	email of the customer
ban	if the customer is banned or not
active	if the customer is active or not
is_delete	if the customer is deleted or not
ext	extension of the customer phone number
country_code	country code of the customermobile number
phone_number	customer phone number
mobile	customer mobile number
agent_sign	*first name of the customer *
account_status	customer account status
assign_group	customer assigned group
primary_dpt	customer primary department
agent_tzone	customer time zone
daylight_save	customer name of the user
limit_access	customer name of the user
directory_listing	customer name of the user
vacation_mode	customer name of the user
company	company name of the customer
role	role of the customer
internal_note	first name of the customer
created_at	creation date of the customer
updated_at	customer profile updated date
user_language	language of the customer