Skip to content

Customers Specific information

Sayar Samanta edited this page Aug 28, 2018 · 2 revisions

Description : This API will fetch all customers registered in the system it will only fetch id, user_name, first_name, last_name, email, phone_number, picture

  1. URL : api/v1/helpdesk/customers-custom

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 list of customers with their profile information

http://www.stablehelpdeskc.faveodemo.com/api/v1/helpdesk/customers-custom?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9wcm9kdWN0ZGVtb3VybC5jb21cL2NvbW11bml0eVwvcHVibGljXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE1MzUwMTE5MjcsImV4cCI6MTUzNTAxMjE2NywibmJmIjoxNTM1MDExOTI3LCJqdGkiOiJBc3UyT3NDZUJXTkljakM0Iiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIn0.4c5kY8nh32jkuPZ0UAqO9OnEwnvQaGC8PEGLmBoT6Xs

JSON Response Example :

Success Response :

{
    "current_page": 1,
    "data": [
        {
            "id": 3,
            "user_name": "ganesh@kailash.com",
            "first_name": "Ganesh",
            "last_name": "",
            "email": "ganesh@kailash.com",
            "phone_number": "",
            "profile_pic": "https://secure.gravatar.com/avatar/4b34f7aab1601f396d2cc2c7cb6d3567?s=80&r=g&d=identicon",
            "company": "ladybird",
            "active": 1,
            "telephone_extension": "",
            "mobile": "9158656569",
            "telephone": "",
            "mobile_code": 91
        }
     ],
    "first_page_url": "http://productdemourl.com/community/public/api/v1/helpdesk/customers-custom?page=1",
    "from": 1,
    "last_page": 4,
    "last_page_url": "http://productdemourl.com/community/public/api/v1/helpdesk/customers-custom?page=4",
    "next_page_url": "http://productdemourl.com/community/public/api/v1/helpdesk/customers-custom?page=2",
    "path": "http://productdemourl.com/community/public/api/v1/helpdesk/customers-custom",
    "per_page": 10,
    "prev_page_url": null,
    "to": 10,
    "total": 40
}

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
email first name of the customer
phone_number first name of the customer
profile_pic first name of the customer
company first name of the customer
active first name of the customer
telephone_extension first name of the customer
mobile first name of the customer
telephone first name of the customer
mobile_code first name of the customer
first_page_url url of the first page
from indicates the first page
last_page indicates the last page
last_page_url url of the last page
next_page_url url of the next page
path path of the url
per_page number of tickets per page
prev_page_url url of the previous page
to number of total pages
total number of tickets

Installation and Upgrade Guide

Administrator's Guide

Agent's Guide

Email Integration

Release & Upgrade Notes

Known Issues

Contribute & Feedback

Knowledge Base

Third Party Integration

Plugins

API

Clone this wiki locally