Collaborator Search

Description : To search for specific collaborator in FAVEO.

29. URL : api/v1/helpdesk/collaborator/search

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
term	String	Required	Key word of user, like first name, last name, email or username

HTTP Method : GET

Response Format : JSON

Response : Returns specific collaborator according to the term.In case of any errors, an error message will be returned.

URL Request Example : http://www.stablehelpdeskc.faveodemo.com/api/v1/helpdesk/collaborator/search?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9wcm9kdWN0ZGVtb3VybC5jb21cL2NvbW11bml0eVwvcHVibGljXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE1MzUwMTU3MjcsImV4cCI6MTUzNTAxNTk2NywibmJmIjoxNTM1MDE1NzI3LCJqdGkiOiJ1aXR3OFkwazFqbXQ0NGczIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIn0.RDRalYYtR90Gh4Dhq2CglGXBy0x0ZW5u-XiH_TZ_LJU

JSON Response Example :

Success Response :

{
    "users": [
        {
            "name": "Ganesh ",
            "email": "ganesh@kailash.com",
            "avatar": "http://productdemourl.com/community/public/uploads/profilepic/https://secure.gravatar.com/avatar/4b34f7aab1601f396d2cc2c7cb6d3567?s=80&r=g&d=identicon"
        }
    ]
}

Some Common Error :

Error Response : If the token is expired

{
“error":"Token has expired"
}

If the term is not provided

{
    "success": false,
    "errors": {
        "term": [
            "The term field is required."
        ]
    }
}

If the token is not provided

 {
  "error": "token_not_provided"
}

Response Description :

Parameter	Description
name	name of the user
email	email of the user
avatar	avatar of the user