Category: Admin Panel

URL: v3/api/admin/delete-department/{id} Method: DELETE Description : Delete a department. Parameters: Parameter Type Optional/Required Description id integer Required Department id of the department to be deleted. Success Response : { “success”:true, “Message”:”Department deletion request has been processed successfully. Department will be deleted shortly after processing its dependencies.” }

URL: v3/api/agent/ticket-count Method: GET Description : Gets ticket count for ticket types inbox, closed, deleted, unapproved Parameters: Parameter Type Optional/Required Description dept-id integer Required Department id to get tickets count Success Response : {  “success”: true,  “data”: { “inbox”: 1, “closed”: 3, “deleted”: 7, “unapproved”: 6  } }  

URL: v3/api/admin/agent Method: POST Description : Creates or Updates a agent/admin Parameters: Parameter Type Optional/Required Description email string Required Agent’s email user_name string Required Agent’s user_name first_name string Required Agent’s first_name last_name string Optional Agents last_name type_ids array Optional Ticket type ids ext integer Optional Agent’s extension phone_number integer Optional Agent’s phone_number country_code integer Optional […]

URL: v3/api/admin/agent/{agent_id} Method: GET Description : Fetches existing agent/admin data based on agent id Parameters: Parameter Type Optional/Required Description agent_id integer Required Agent/Admin id Success Response : {  “success”: true,  “data”: { “agent”: [   {     “id”: 99,     “first_name”: “Krishna”,     “last_name”: “Vishwakarma”,     “user_name”: “krishna”,     “location”: “bangalore”,     “role”: “agent”,     […]

URL: v3/api/admin/get-agent/{agentId} Method: GET Description : Fetches existing Agent/Admin data Parameters: Parameter Type Optional/Required Description agentId integer Required Agent/Admin id Success Response : {  “success”: true,  “data”: { “agent”: [   {     “id”: 101,     “user_name”: “krishna”,     “role”: “agent”,     “email”: “krishna@faveo.com”,     “profile_pic”: “https://secure.gravatar.com/avatar/d15e173f92f94fd80a5ef7773a19b25e?s=80&r=g&d=identicon”,     “ext”: “080”,     “country_code”: 91,     “mobile”: […]

URL: v3/api/admin/change-agent/{agent_id} Method: GET Description : Fetches existing Agent/Admin data to change role, password, active field. Parameters: Parameter Type Optional/Required Description agent_id integer Required Agent/Admin id email string Optional Agent/Admin changed email role string Optional Agent/Admin changed role password String Optional Agent/Admin changed password active integer Optional Agent/Admin activate/deactivate Success Response : { “success”:true, “Message”:”Email […]

URL: api/admin/get-users-list Method: GET Description : Fetches list of users Parameters: Parameter Type Optional/Required Description search-query string Optional Search Query sort-order string Optional ‘asc’ or ‘desc’ sort-field string Optional User’s field based on which sorting will be done. By default, it is set to id. limit integer Optional Number of records needed in a page. […]

URL: v3/api/admin/ticket-count-user Method: GET Description : Gets ticket count for ticket types inbox, closed, deleted, unapproved Parameters: Parameter Type Optional/Required Description user-id integer Required user id to get tickets count Success Response : {  “success”: true,  “data”: { “inbox”: 1, “closed”: 3, “deleted”: 7, “unapproved”: 6  } }  

URL: v3/api/admin/team-agents Method: GET Description : Fetches existing team data Parameters: Parameter Type Optional/Required Description teamId integer Required Team id Success Response : {  “success”: true,  “data”: {    “members”: [      {        “id”: 3,        “email”: “ashley@faveo.com”,        “profile_pic”: “http://faveo-helpdesk-advance/public/lb-faveo/media/images/contacthea.png”,        “name”: “Ashley Knite”      },      {        “id”: 4,        “email”: “tim@faveo.com”,        “profile_pic”: “http://faveo-helpdesk-advance/public/lb-faveo/media/images/contacthea.png”,        “name”: “Tim West”      },      {        “id”: 5, […]

URL: v3/api/admin/team-members/{teamId} Method: GET Description : Fetches existing team members based on team id Parameters: Parameter Type Optional/Required Description teamId integer Required Team id Success Response : {  “success”: true,  “data”: {    “current_page”: 1,    “data”: [      {        “id”: 3,        “user_name”: “ashley”,        “role”: “admin”,        “active”: 1,        “email_verify”: “1”,        “mobile_otp_verify”: “1”,        “ban”: 0,        “is_delete”: 0,        “created_at”: “2017-03-29 […]