Authenticates a user and gives his/her profile information back if successful.

URL: v3/api/login

Method: POST

Response Format: JSON

Parameters :

Name Data Type Required / Optional Description
user_name String Required Username of the Agent
password String Required Password of the Agent

Success Response :


"success": true,

"data": {

    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODAwMC9hcGkvbG9naW4iLCJpYXQiOjE1MTg2MDI1NTAsImV4cCI6MTUxODYwMjc5MCwibmJmIjoxNTE4NjAyNTUwLCJqdGkiOiJpTjFMSkl5M0U2UXB5aUpaIn0.QrXxRYlowT4v2BayTNvapnHUe1vMJ_NlXydgJoS7y1E",

    "user": {

        "id": 1,

        "user_name": "",

        "first_name": "Avinash",

        "last_name": "Kumar",

        "gender": "0",

        "email": "",

        "ban": "0",

        "active": "1",

        "is_delete": "0",

        "ext": "",

        "country_code": "",

        "phone_number": "",

        "mobile": "Not available",

        "agent_sign": "",

        "account_type": "",

        "account_status": "",

        "assign_group": "1",

        "primary_dpt": "1",

        "agent_tzone": "",

        "daylight_save": "",

        "limit_access": "",

        "directory_listing": "",

        "vacation_mode": "",

        "company": "",

        "role": "admin",

        "internal_note": "",

        "profile_pic": "",

        "fcm_token": null,

        "i_token": null,

        "created_at": "2018-02-12 08:43:56",

        "updated_at": "2018-02-14 07:21:44",

        "location": null,

        "user_language": null,

        "mobile_otp_verify": "1",

        "email_verify": "1",

        "is_login": "1",

        "not_accept_ticket": "0",

        "ldap_username": "",

        "isldapauth": "0"





Next, read How to pass OAuth2 token in API version 3



  1. Rich Murray

    I am able to successfully POST to Login and get a token back.

    I am unable to use the token for retrieving subsequent ticket information and token is not listed as a parameter in any of the new ticket APIs.

    Providing it as “token” or not simply results in:
    {“result”:{“fails”:”Unauthorized! Please login again”}}

    How do I retrieve ticket info with the ne APIs?

Leave a Reply

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