This v1 API  will be deprecated from 15th March 2020

Description:

To fetch all customers in Faveo.

URL : api/v1/helpdesk/customers

          (Replace this URL with you helpdesk URL)

Parameters :

Name Data Type Required / Optional Description
api_key String Required An alphanumeric code that can be used to authenticate your API calls
ip String Optional IP address of the Customer/location where API call is being made from
token String Required Token generated for a user

HTTP Method : GET         

  •   URL Request Example:

https://www.stablehelpdesk.faveodemo.com/api/v1/helpdesk/customers?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6Ly9wcm9kdWN0ZGVtb3VybC5jb20vc2FyZnJhei9wdWJsaWMvYXBpL3YxL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTUzNDc1OTg5MiwiZXhwIjoxNTM0NzYwMTMyLCJuYmYiOjE1MzQ3NTk4OTIsImp0aSI6IlhBdzNrNGhwZXNUVWNFeVQifQ.TpuZ6Vwo9oMlt_LKRZYv2cU5UY8YBKqe06-66ioZA24

Response

  •   Response Format: JSON
  •   Returns JSON which contains below response

Sample JSON Success Response :

{

"result":[

{

   "result": [

       {

           "id": 4,

           "user_name": "chetan@gmail.com",

           "first_name": "Chetan",

           "last_name": "K",

           "gender": 0,

           "email": "chetan@gmail.com",

           "ban": 0,

           "active": 1,

           "is_delete": 0,

           "ext": "",

           "country_code": "",

           "phone_number": "",

           "mobile": "Not available",

           "agent_sign": "",

           "account_type": "",

           "account_status": "",

           "assign_group": null,

           "primary_dpt": null,

           "agent_tzone": "81",

           "daylight_save": "",

           "limit_access": "",

           "directory_listing": "",

           "vacation_mode": "",

           "company": "",

           "role": "user",

           "internal_note": "",

           "profile_pic": "https://secure.gravatar.com/avatar/f9e2d691518c682722d057e06c29ecee?s=80&r=g&d=identicon",

           "fcm_token": null,

           "i_token": null,

           "created_at": "2018-03-27 11:51:43",

           "updated_at": "2018-03-27 11:51:43",

           "user_language": null,

           "mobile_otp_verify": "OBPJumOhajkQwLb60x07zq4qJyaVDSXq3YxCzDE4R86Ti4YT4pvvi3IeoFC5",

           "email_verify": "OBPJumOhajkQwLb60x07zq4qJyaVDSXq3YxCzDE4R86Ti4YT4pvvi3IeoFC5",

           "location": "",

           "is_login": 0,

           "not_accept_ticket": 0

       },

         {

           "id": 18,

           "user_name": "suyesh@gmail.com",

           "first_name": "Suyesh",

           "last_name": "Powar",

           "gender": 0,

           "email": "suyesh@gmail.com",

           "ban": 0,

           "active": 1,

           "is_delete": 0,

           "ext": "",

           "country_code": "",

           "phone_number": "",

           "mobile": "Not available",

           "agent_sign": "",

           "account_type": "",

           "account_status": "",

           "assign_group": null,

           "primary_dpt": null,

           "agent_tzone": "81",

           "daylight_save": "",

           "limit_access": "",

           "directory_listing": "",

           "vacation_mode": "",

           "company": "",

           "role": "user",

           "internal_note": "",

           "profile_pic": "https://secure.gravatar.com/avatar/f9e2d691518c682722d057e06c29ecee?s=80&r=g&d=identicon",

           "fcm_token": null,

           "i_token": null,

           "created_at": "2018-03-27 11:51:43",

           "updated_at": "2018-03-27 11:51:43",

           "user_language": null,

           "mobile_otp_verify": "OBPJumOhajkQwLb60x07zq4qJyaVDSXq3YxCzDE4R86Ti4YT4pvvi3IeoFC5",

           "email_verify": "OBPJumOhajkQwLb60x07zq4qJyaVDSXq3YxCzDE4R86Ti4YT4pvvi3IeoFC5",

           "location": "",

           "is_login": 0,

           "not_accept_ticket": 0

       },

        {

           "id": 19,

           "user_name": "karan@gmail.com",

           "first_name": "Karan",

           "last_name": "Kumar",

           "gender": 0,

           "email": "karan@gmail.com",

           "ban": 0,

           "active": 1,

           "is_delete": 0,

           "ext": "",

           "country_code": "",

           "phone_number": "",

           "mobile": "Not available",

           "agent_sign": "",

           "account_type": "",

           "account_status": "",

           "assign_group": null,

           "primary_dpt": null,

           "agent_tzone": "81",

           "daylight_save": "",

           "limit_access": "",

           "directory_listing": "",

           "vacation_mode": "",

           "company": "",

           "role": "user",

           "internal_note": "",

           "profile_pic": "https://secure.gravatar.com/avatar/f9e2d691518c682722d057e06c29ecee?s=80&r=g&d=identicon",

           "fcm_token": null,

           "i_token": null,

           "created_at": "2018-03-27 11:51:43",

           "updated_at": "2018-03-27 11:51:43",

           "user_language": null,

           "mobile_otp_verify": "OBPJumOhajkQwLb60x07zq4qJyaVDSXq3YxCzDE4R86Ti4YT4pvvi3IeoFC5",

           "email_verify": "OBPJumOhajkQwLb60x07zq4qJyaVDSXq3YxCzDE4R86Ti4YT4pvvi3IeoFC5",

           "location": "",

           "is_login": 0,

           "not_accept_ticket": 0

       },

        {

           "id": 20,

           "user_name": "vishal@gmail.com",

           "first_name": "Vishal",

           "last_name": "Patel",

           "gender": 0,

           "email": "vishal@gmail.com",

           "ban": 0,

           "active": 1,

           "is_delete": 0,

           "ext": "",

           "country_code": "",

           "phone_number": "",

           "mobile": "Not available",

           "agent_sign": "",

           "account_type": "",

           "account_status": "",

           "assign_group": null,

           "primary_dpt": null,

           "agent_tzone": "81",

           "daylight_save": "",

           "limit_access": "",

           "directory_listing": "",

           "vacation_mode": "",

           "company": "",

           "role": "user",

           "internal_note": "",

           "profile_pic": "https://secure.gravatar.com/avatar/f9e2d691518c682722d057e06c29ecee?s=80&r=g&d=identicon",

           "fcm_token": null,

           "i_token": null,

           "created_at": "2018-03-27 11:51:43",

           "updated_at": "2018-03-27 11:51:43",

           "user_language": null,

           "mobile_otp_verify": "OBPJumOhajkQwLb60x07zq4qJyaVDSXq3YxCzDE4R86Ti4YT4pvvi3IeoFC5",

           "email_verify": "OBPJumOhajkQwLb60x07zq4qJyaVDSXq3YxCzDE4R86Ti4YT4pvvi3IeoFC5",

           "location": "",

           "is_login": 0,

           "not_accept_ticket": 0

       }

}

]

}

Response Description:

  *click here to check

Possible Errors/Failures:

 *Please check the responses for some common errors

Leave a Reply

Your email address will not be published. Required fields are marked *