This v1 API  will be deprecated from 15th March 2020

Description:

This API we are using to get the details of a user registered on Faveo. We have to pass the user id to get the details of the user.

URL : api/v1/helpdesk/customer

           (Replace this URL with you helpdesk URL)

Parameters :

Name Data Type Required / Optional Description
api_key String optional 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
user_id Integer Required Id of the customer

HTTP Method : GET         

  •   URL Request Example:

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

Response

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

Sample JSON Success Response :

{

   "success": true,

"data": {

"user": {

           "id": 34,

           "user_name": "danish",

           "first_name": "danish",

           "last_name": "john",

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

           "role": "user",

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

       }

   }

}

Response Description: It gives a user JSON which contains  customer details

Parameter Description
id It is the unique id of the customer
user_name It is the username of the customer
first_name It is the first name of the customer
last_name It is the last name of the customer
email It is the email of the customer
role It is the role of the customer
profile_pic It is the profile picture of the customer

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 *