{"info":{"_postman_id":"704255f1-39a4-40a1-8ffa-80b3f1e341d8","name":"Helpical G2 | API Docs","description":"<html><head></head><body><p><em>Last update: 2026-05-11</em></p>\n<p><a href=\"https://helpical.com\">Helpical</a> is an IT helpdesk &amp; ticketing system. Using its APIs, you are able to link your own software, websites, and applications to it, and do everything your end users could do in Helpical application itself inside your platform.<br>Note: Your managers, supervisors, and staff should work with Helpical GUI and there is not any API for their side at the moment.</p>\n<h2 id=\"important-notes\">Important notes:</h2>\n<h5 id=\"postman-collection\">Postman Collection</h5>\n<p>If you wonder to use our Postman collection, you can find it at <a href=\"https://documenter.getpostman.com/view/8560811/2s8YzP2QGf\">this link</a>.</p>\n<h5 id=\"url-format\">URL format</h5>\n<ol>\n<li><p>The base form of Helpical external APIs URL is similar to <code>https://{{SYSTEM_URL}}/api/external/{{METHOD_NAME}}</code><br> which <code>{{SYSTEM_URL}}</code> should be replaced with your license URL, and <code>{{METHOD_NAME}}</code> will be different values based on your API call purpose.</p>\n</li>\n<li><p><code>application/json</code> must be set as the <code>Content-Type</code> to send body data in JSON format. However, if you need to upload files, you should set the <code>Content-Type</code> to <code>multipart/form-data</code></p>\n</li>\n</ol>\n<h5 id=\"authorization\">Authorization</h5>\n<ol>\n<li><p>To work with these APIs, admin should create a <strong>secret key</strong> in <strong>General Settings &gt; Security</strong> inside Helpical software. Then, while calling APIs, this secret key should be sent in the HTTP headers with the name <strong>x-api-key</strong>.</p>\n</li>\n<li><p>All API calls are allowed to be executed over secure connections (SSL). If you have any issue on SSL certificate of Helpical software, please contact Helpical support team to get the appropriate information in this regard. It is highly recommended to activate SSL on your applications/websites too.</p>\n</li>\n<li><p>To increase the security, APIs can be available from specific IP(s). Admin can set these IP(s) within the <strong>General Settings &gt; Security</strong> section.</p>\n</li>\n</ol>\n<h5 id=\"error-codes\">Error codes</h5>\n<p>In all API calls, you will get HTTP status codes as well as other details belonging to errors if there is any.</p>\n<h5 id=\"rate-limit\">Rate limit</h5>\n<p>Based on your purchased license type (Corporate/Enterprise), you have a specific rate limit per minute. All your API calls (after successful authorization, and regardless of their final results) will be counted, and if you reach your limit, your further requests will be rejected with the HTTP <code>429 Too Many Requests</code> status. To check the rate limit of your licenses, please <a href=\"https://helpical.com/price/?utm_source=documentations&amp;utm_medium=postman\">click here</a>.</p>\n<h5 id=\"bug-reporting\">Bug reporting</h5>\n<p>If you find any bug in APIs or any mistake in this documentation, please inform us by sending an email to <a href=\"https://mailto:admin@helpiacl.com\">admin@helpical.com</a>. We appreciate your attention and cooperation in advance.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8560811","collectionId":"704255f1-39a4-40a1-8ffa-80b3f1e341d8","publishedId":"2s8YzP2QGf","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-12-06T10:18:48.000Z"},"item":[{"name":"Customers' organizations","item":[{"name":"Organizations list","id":"be6c1f4f-77bb-48fe-b09d-a953a7ba1783","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{YOUR_API_KEY}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://{{SYSTEM_URL}}/api/external/organizations","description":"<p>To fetch the list of your desired customers' orgnziations, call this API and use any filter in case of need. Each API call, returns 10 rows from database and you can use the <code>page</code> parameter to fetch the next items.</p>\n<h5 id=\"filters-params\">Filters params:</h5>\n<ul>\n<li><p>page: Integer (For pagination)</p>\n</li>\n<li><p>keyword: String (Keyword in customer full name)</p>\n</li>\n<li><p>customer_levels: Array of integers (from systemDefaults API)</p>\n</li>\n<li><p>from_expire: Date (Unix timestamp)</p>\n</li>\n<li><p>to_expire: Date (Unix timestamp), Optional</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","external","organizations"],"host":["{{SYSTEM_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"be6c1f4f-77bb-48fe-b09d-a953a7ba1783"},{"name":"Organization information","id":"ff2b8abd-fd7c-4f2b-8c2c-23b23ca0781f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{YOUR_API_KEY}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://{{SYSTEM_URL}}/api/external/organizations/:id","description":"<p>This API, gives you all the information of a specific customer organization by sending it's ID.</p>\n","urlObject":{"protocol":"https","path":["api","external","organizations",":id"],"host":["{{SYSTEM_URL}}"],"query":[],"variable":[{"description":{"content":"<p>Organization ID</p>\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"ff2b8abd-fd7c-4f2b-8c2c-23b23ca0781f"},{"name":"New organization","id":"9d2adbec-e700-4e92-87bd-5aa530ff2cbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{YOUR_API_KEY}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"name\":\"\",\r\n    \"description\":\"\",\r\n    \"phone\":\"\",\r\n    \"website\":\"\",\r\n    \"customer_level_id\":\"\",\r\n    \"expire_date\":\"\",\r\n    \"assigned_departments\":[\r\n        {\r\n            \"department_id\":\"\",\r\n            \"meta_data\":{\r\n                \"limit\":\"\",\r\n                \"expired_at\":\"\"\r\n            }\r\n        }\r\n    ],\r\n    \"assigned_services\":[\r\n        {\r\n            \"service_id\":\"\",\r\n            \"meta_data\":{\r\n                \"limit\":\"\",\r\n                \"expired_at\":\"\"\r\n            }\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{SYSTEM_URL}}/api/external/organizations","description":"<p>Using this API, you can create a new customer organization in Helpical. If you have an Enterprise license, you are able to limit this organization on specific departments or serivces by setting remained tickets or expire date of department/service accessibility.</p>\n<h5 id=\"inputs\">Inputs</h5>\n<ul>\n<li><p>name: String, Required</p>\n</li>\n<li><p>description: String, Optional</p>\n</li>\n<li><p>phone: String, Optional</p>\n</li>\n<li><p>website: String, Optional</p>\n</li>\n<li><p>custoemr_level_id: Integer, Required (From systemDefaults API)</p>\n</li>\n<li><p>expire_date: Date (Unix timestamp), Optional</p>\n</li>\n<li><p>assigned_departments: Array, Optional (Array of object elements are as below)</p>\n<ul>\n<li><p>department_id: Integer, Optional (From systemDefaults API)</p>\n</li>\n<li><p>meta_data: Object, Optional</p>\n<ul>\n<li><p>limit: Integer, Optional</p>\n</li>\n<li><p>expired_at: Date (Unix timestamp), Optional</p>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n<li><p>assigned_services: Array, Optional (Array of object elements are as below)</p>\n<ul>\n<li><p>service_id: Integer, Optional (From systemDefaults API)</p>\n</li>\n<li><p>meta_data: Object, Optional</p>\n<ul>\n<li><p>limit: Integer, Optional</p>\n</li>\n<li><p>expired_at: Date (Unix timestamp), Optional</p>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","external","organizations"],"host":["{{SYSTEM_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d2adbec-e700-4e92-87bd-5aa530ff2cbf"},{"name":"Update organization","id":"7ba359f2-cbbc-45d5-8a3c-458bc41a832c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{YOUR_API_KEY}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"name\":\"\",\r\n    \"description\":\"\",\r\n    \"phone\":\"\",\r\n    \"website\":\"\",\r\n    \"customer_level_id\":\"\",\r\n    \"expire_date\":\"\",\r\n    \"assigned_departments\":[\r\n        {\r\n            \"department_id\":\"\",\r\n            \"meta_data\":{\r\n                \"limit\":\"\",\r\n                \"expired_at\":\"\"\r\n            }\r\n        }\r\n    ],\r\n    \"assigned_services\":[\r\n        {\r\n            \"service_id\":\"\",\r\n            \"meta_data\":{\r\n                \"limit\":\"\",\r\n                \"expired_at\":\"\"\r\n            }\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{SYSTEM_URL}}/api/external/organizations/:id","description":"<p>To modify an organization, use this API with the below inputs. Consider that you should pass the organization ID as path variable (In URL)</p>\n<h5 id=\"inputs\">Inputs</h5>\n<ul>\n<li><p>name: String, Optional</p>\n</li>\n<li><p>description: String, Optional</p>\n</li>\n<li><p>phone: String, Optional</p>\n</li>\n<li><p>website: String, Optional</p>\n</li>\n<li><p>custoemr_level_id: Integer, Optional (From systemDefaults API)</p>\n</li>\n<li><p>expire_date: Date (Unix timestamp), Optional</p>\n</li>\n<li><p>assigned_departments: Array, Optional (Array of object elements are as below)</p>\n<ul>\n<li><p>department_id: Integer, Optional (From systemDefaults API)</p>\n</li>\n<li><p>meta_data: Object, Optional</p>\n<ul>\n<li><p>limit: Integer, Optional</p>\n</li>\n<li><p>expired_at: Date (Unix timestamp), Optional</p>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n<li><p>assigned_services: Array, Optional (Array of object elements are as below)</p>\n<ul>\n<li><p>service_id: Integer, Optional (From systemDefaults API)</p>\n</li>\n<li><p>meta_data: Object, Optional</p>\n<ul>\n<li><p>limit: Integer, Optional</p>\n</li>\n<li><p>expired_at: Date (Unix timestamp), Optional</p>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","external","organizations",":id"],"host":["{{SYSTEM_URL}}"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"7ba359f2-cbbc-45d5-8a3c-458bc41a832c"},{"name":"Delete organization","id":"3ef17a32-e085-4686-a04b-5c09fceeeda5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{YOUR_API_KEY}}"}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":""},"url":"https://{{SYSTEM_URL}}/api/external/organizations/:id","description":"<p>If you decided to remove a customers organization, you can use this API by sending HELPICAL_ORGANIZATION_ID.</p>\n","urlObject":{"protocol":"https","path":["api","external","organizations",":id"],"host":["{{SYSTEM_URL}}"],"query":[],"variable":[{"description":{"content":"<p>Orgnizations ID</p>\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"3ef17a32-e085-4686-a04b-5c09fceeeda5"}],"id":"18ac2484-4970-4b17-b011-4881bc4918e1","_postman_id":"18ac2484-4970-4b17-b011-4881bc4918e1","description":""},{"name":"Customer users","item":[{"name":"Customers list","id":"2d3c2724-0a76-4fb0-846f-14b98cda7404","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{YOUR_API_KEY}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://{{SYSTEM_URL}}/api/external/customers","description":"<p>To fetch the list of your desired customers, call this API and use any filter in case of need. Each API call, returns 10 rows from database and you can use the <code>page</code> parameter to fetch the next items.</p>\n<h5 id=\"filters-params\">Filters params:</h5>\n<ul>\n<li><p>page: Integer (For pagination)</p>\n</li>\n<li><p>keyword: String (Keyword in customer full name)</p>\n</li>\n<li><p>description_keyword: String (Keyword in customer description)</p>\n</li>\n<li><p>email: String</p>\n</li>\n<li><p>mobile: String</p>\n</li>\n<li><p>username: String</p>\n</li>\n<li><p>status: Integer (0: disabled, 1: active)</p>\n</li>\n<li><p>organizations: Array of integers (from systemDefaults API)</p>\n</li>\n<li><p>customer_levels: Array of integers (from systemDefaults API)</p>\n</li>\n<li><p>from_expire: Date (Unix timestamp)</p>\n</li>\n<li><p>to_expire: Date (Unix timestamp)</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","external","customers"],"host":["{{SYSTEM_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2d3c2724-0a76-4fb0-846f-14b98cda7404"},{"name":"Customer information","id":"c6054d5f-c2a5-4915-a373-19c2fabdab0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{YOUR_API_KEY}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://{{SYSTEM_URL}}/api/external/customers/:id","description":"<p>By this API, you will get the basic information of one specific customer by sending his/her HELPICAL_CUSTOMER_ID.</p>\n","urlObject":{"protocol":"https","path":["api","external","customers",":id"],"host":["{{SYSTEM_URL}}"],"query":[],"variable":[{"description":{"content":"<p>Customer ID</p>\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"c6054d5f-c2a5-4915-a373-19c2fabdab0c"},{"name":"New customer","id":"c9d78c96-6fd3-4242-994d-1d550a3d4dc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{YOUR_API_KEY}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"status\": \"\",\r\n    \"first_name\": \"\",\r\n    \"last_name\": \"\",\r\n    \"email\": \"\",\r\n    \"mobile\": \"\",\r\n    \"username\": \"\",\r\n    \"gender\": \"\",\r\n    \"password\": \"\",\r\n    \"password_confirmation\": \"\",\r\n    \"landline\": \"\",\r\n    \"interphone\": \"\",\r\n    \"birthday\": \"\",\r\n    \"customer_level_id\": \"\",\r\n    \"organization_id\": \"\",\r\n    \"supervisor\": \"\",\r\n    \"position\": \"\",\r\n    \"description\": \"\",\r\n    \"expire_date\": \"\",\r\n    \"assigned_departments\":[\r\n        {\r\n            \"department_id\":\"\",\r\n            \"meta_data\":{\r\n                \"limit\":\"\",\r\n                \"expired_at\":\"\"\r\n            }\r\n        }\r\n    ],\r\n    \"assigned_services\":[\r\n        {\r\n            \"service_id\":\"\",\r\n            \"meta_data\":{\r\n                \"limit\":\"\",\r\n                \"expired_at\":\"\"\r\n            }\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{SYSTEM_URL}}/api/external/customers","description":"<p>Call this API when you want to create a new account for a customer.</p>\n<h5 id=\"inputs\">Inputs</h5>\n<ul>\n<li><p>status: Boolean, Optional (true: enable, false: disable)</p>\n</li>\n<li><p>first_name: String, Required</p>\n</li>\n<li><p>last_name: String, Required</p>\n</li>\n<li><p>email: String, Optional|Required (Based on settings)</p>\n</li>\n<li><p>mobile: String, Optional|Required (Based on settings)</p>\n</li>\n<li><p>username: String, Optional|Required (Based on settings)</p>\n</li>\n<li><p>gender: Boolean, Nullable, Optional(true: Male, false: Female, null: Other)</p>\n</li>\n<li><p>password: String, Optional (Will be generated automatically if not set)</p>\n</li>\n<li><p>password_confirmation: String, Optional (Will be generated automatically if not set)</p>\n</li>\n<li><p>landline: String, Optional</p>\n</li>\n<li><p>interphone: String, Optional</p>\n</li>\n<li><p>birthday: Date (Unix timestamp), Optional</p>\n</li>\n<li><p>organization_id: Integer, Required (From systemDefaults API)</p>\n</li>\n<li><p>customer_level_id: Integer, Required(From systemDefaults API)</p>\n</li>\n<li><p>supervisor: Boolean, Optional (true: Organization supervisor, false: Normal customer)</p>\n</li>\n<li><p>position: String, Optional</p>\n</li>\n<li><p>description: String, Optional</p>\n</li>\n<li><p>expire_date: Date (Unix timestamp), Optional</p>\n</li>\n<li><p>assigned_departments: Array, Optional (Array of object elements are as below)</p>\n<ul>\n<li><p>department_id: Integer, Optional (From systemDefaults API)</p>\n</li>\n<li><p>meta_data: Object, Optional</p>\n<ul>\n<li><p>limit: Integer, Optional</p>\n</li>\n<li><p>expired_at: Date (Unix timestamp), Optional</p>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n<li><p>assigned_services: Array, Optional (Array of object elements are as below)</p>\n<ul>\n<li><p>service_id: Integer, Optional (From systemDefaults API)</p>\n</li>\n<li><p>meta_data: Object, Optional</p>\n<ul>\n<li><p>limit: Integer, Optional</p>\n</li>\n<li><p>expired_at: Date (Unix timestamp), Optional</p>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n<li><p>customer_fields (Deprecated from 2026/05/09)</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","external","customers"],"host":["{{SYSTEM_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c9d78c96-6fd3-4242-994d-1d550a3d4dc8"},{"name":"Update customer","id":"b1c7719f-b993-49c4-85c9-f7079927f806","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{YOUR_API_KEY}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"status\": \"\",\r\n    \"first_name\": \"\",\r\n    \"last_name\": \"\",\r\n    \"email\": \"\",\r\n    \"mobile\": \"\",\r\n    \"username\": \"\",\r\n    \"gender\": \"\",\r\n    \"password\": \"\",\r\n    \"password_confirmation\": \"\",\r\n    \"landline\": \"\",\r\n    \"interphone\": \"\",\r\n    \"birthday\": \"\",\r\n    \"customer_level_id\": \"\",\r\n    \"organization_id\": \"\",\r\n    \"supervisor\": \"\",\r\n    \"position\": \"\",\r\n    \"description\": \"\",\r\n    \"expire_date\": \"\",\r\n    \"assigned_departments\":[\r\n        {\r\n            \"department_id\":\"\",\r\n            \"meta_data\":{\r\n                \"limit\":\"\",\r\n                \"expired_at\":\"\"\r\n            }\r\n        }\r\n    ],\r\n    \"assigned_services\":[\r\n        {\r\n            \"service_id\":\"\",\r\n            \"meta_data\":{\r\n                \"limit\":\"\",\r\n                \"expired_at\":\"\"\r\n            }\r\n        }\r\n    ]\r\n}"},"url":"https://{{SYSTEM_URL}}/api/external/customers/:id","description":"<p>This API lets you update the details for customers belonging to HELPICAL_CUSTOMER_ID which you sent it in URL.</p>\n<h5 id=\"inputs\">Inputs</h5>\n<ul>\n<li><p>first_name: String, Optional</p>\n</li>\n<li><p>last_name: String, Optional</p>\n</li>\n<li><p>email: String, Optional</p>\n</li>\n<li><p>mobile: String, Optional</p>\n</li>\n<li><p>username: String, Optional</p>\n</li>\n<li><p>gender: Boolean, Nullable, Optional (True: Male, False: Female, Null: Other)</p>\n</li>\n<li><p>password: String, Optional</p>\n</li>\n<li><p>password_confirmation: String, Optional</p>\n</li>\n<li><p>landline: String, Optional</p>\n</li>\n<li><p>interphone: String, Optional</p>\n</li>\n<li><p>birthday: Date (Unix timestamp), Optional</p>\n</li>\n<li><p>customer_level_id: Integer, Optional (From systemDefaults API)</p>\n</li>\n<li><p>organization_id: Integer, Optional (From systemDefaults API)</p>\n</li>\n<li><p>supervisor: Boolean, Optional (true: Organization supervisor, false: Normal customer)</p>\n</li>\n<li><p>position: String, Optional</p>\n</li>\n<li><p>description: String, Optional</p>\n</li>\n<li><p>expire_date: Date (Unix timestamp), Optional</p>\n</li>\n<li><p>assigned_departments: Array, Optional (Array of object elements are as below)</p>\n<ul>\n<li><p>department_id: Integer, Optional (From systemDefaults API)</p>\n</li>\n<li><p>meta_data: Object, Optional</p>\n<ul>\n<li><p>limit: Integer, Optional</p>\n</li>\n<li><p>expired_at: Date (Unix timestamp), Optional</p>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n<li><p>assigned_services: Array, Optional (Array of object elements are as below)</p>\n<ul>\n<li><p>service_id: Integer, Optional (From systemDefaults API)</p>\n</li>\n<li><p>meta_data: Object, Optional</p>\n<ul>\n<li><p>limit: Integer, Optional</p>\n</li>\n<li><p>expired_at: Date (Unix timestamp), Optional</p>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n<li><p>customer_fields (Deprecated from 2026/05/09)</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","external","customers",":id"],"host":["{{SYSTEM_URL}}"],"query":[],"variable":[{"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"b1c7719f-b993-49c4-85c9-f7079927f806"},{"name":"Delete customer","id":"8d2c931d-7437-471a-b50a-9bd03917f500","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{YOUR_API_KEY}}"}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":""},"url":"https://{{SYSTEM_URL}}/api/external/customers/:id","description":"<p>If you decided to remove a customer, you can use this API by sending HELPICAL_CUSTOMER_ID.</p>\n","urlObject":{"protocol":"https","path":["api","external","customers",":id"],"host":["{{SYSTEM_URL}}"],"query":[],"variable":[{"description":{"content":"<p>Customer ID</p>\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"8d2c931d-7437-471a-b50a-9bd03917f500"},{"name":"New event for customer","id":"fad4dbc4-fe15-4652-8dae-6ad003eed5a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{YOUR_API_KEY}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n    \"user_id\": \"\",\r\n    \"user_email\": \"\",\r\n    \"user_mobile\":\"\",\r\n    \"user_username\": \"\",\r\n    \"description\":\"\"\r\n}"},"url":"https://{{SYSTEM_URL}}/api/external/storeCustomerEvent/:slug","description":"<p>This API creates an external event for customer's profile. The <code>SLUG</code> in URL is the generated GUID for your desired event inside administration panel. To assign event to a customer, you should pass one of 4 first items in this API.</p>\n<p><strong>INPUTS:</strong></p>\n<ul>\n<li><p>user_id: String, Optional</p>\n</li>\n<li><p>user_email: String, Optional</p>\n</li>\n<li><p>user_mobile: String, Optional</p>\n</li>\n<li><p>user_username: String, Optional</p>\n</li>\n<li><p>description: String, Optional</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","external","storeCustomerEvent",":slug"],"host":["{{SYSTEM_URL}}"],"query":[],"variable":[{"type":"any","value":null,"key":"slug"}]}},"response":[],"_postman_id":"fad4dbc4-fe15-4652-8dae-6ad003eed5a8"}],"id":"c680e435-118d-4b03-ad0d-86b6c3ddbcd5","description":"<p>Here, you can manage main customer actions and retrieve their details.</p>\n","_postman_id":"c680e435-118d-4b03-ad0d-86b6c3ddbcd5"},{"name":"Ticket APIs","item":[{"name":"Tickets list","id":"682b3da7-92cb-4090-96ce-04f27cf5fcab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{YOUR_API_KEY}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://{{SYSTEM_URL}}/api/external/tickets","description":"<p>To fetch the list of your desired tickets, call this API and use any filter in case of need.</p>\n<h5 id=\"filters-params\">Filters params:</h5>\n<ul>\n<li><p>page: Integer (For pagination)</p>\n</li>\n<li><p>keyword: String (Keyword in subject title)</p>\n</li>\n<li><p>from_date: Date (Unix timestamp)</p>\n</li>\n<li><p>to_date: Date (Unix timestamp)</p>\n</li>\n<li><p>from_update_date: Date (Unix timestamp)</p>\n</li>\n<li><p>to_update_date: Date (Unix timestamp)</p>\n</li>\n<li><p>from_id: Integer (Ticket number)</p>\n</li>\n<li><p>to_id: Integer (Ticket number)</p>\n</li>\n<li><p>from_departments: Array of integers (from systemDefaults API)</p>\n</li>\n<li><p>to_departments: Array of integers (from systemDefaults API)</p>\n</li>\n<li><p>ticket_statuses: Array of integers (0: open, 1: pending/progressing, 2: employee_answered, 3: customer_answered, 4: closed)</p>\n</li>\n<li><p>importances: Array of integers (1: low, 2: normal, 3: high, 4: critical)</p>\n</li>\n<li><p>satisfactions: Array of integers (1 to 5)</p>\n</li>\n<li><p>ticket_categories: Array of integers (from systemDefaults API)</p>\n</li>\n<li><p>services: Array of integers (from systemDefaults API)</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","external","tickets"],"host":["{{SYSTEM_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"682b3da7-92cb-4090-96ce-04f27cf5fcab"},{"name":"Ticket information","id":"d1e2f27b-25b5-4883-ba87-46c452b43daa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{YOUR_API_KEY}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://{{SYSTEM_URL}}/api/external/tickets/:id","description":"<p>This API returns the information belonging to a specific ticket which you have mentioned its ID in URL.</p>\n<p>Note: One of the user_id, user_mobile, user_email, or user_username parameters should be sent for this API as a json request body too.</p>\n","urlObject":{"protocol":"https","path":["api","external","tickets",":id"],"host":["{{SYSTEM_URL}}"],"query":[],"variable":[{"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"d1e2f27b-25b5-4883-ba87-46c452b43daa"},{"name":"New ticket","id":"a0eaac44-2e14-4933-9db8-1f1628e3f4f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{YOUR_API_KEY}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"title","value":"","type":"text"},{"key":"content","value":"","type":"text"},{"key":"to_department","value":"","type":"text"},{"key":"ticket_category_id","value":"","type":"text"},{"key":"service_id","value":"","type":"text"},{"key":"importance","value":"","type":"text"},{"key":"attachements[]","type":"file","value":null}]},"url":"https://{{SYSTEM_URL}}/api/external/tickets","description":"<p>To create a new ticket for your customer, use this API considering the inputs below:</p>\n<p>Header <code>Content-Type</code> in this API should be set as <code>multipart/form-data</code> if you need to send attachments for replies, otherwise, set<code>application/json</code> as <code>Content-Type</code> header.</p>\n<h5 id=\"inputs\">Inputs</h5>\n<ul>\n<li><p>title: String, Required (Max length: 60 Characters)</p>\n</li>\n<li><p>content: String, Required</p>\n</li>\n<li><p>to_department: Integer, Required (from systemDefaults API)</p>\n</li>\n<li><p>ticket_category_id: Integer, Required/Nullable (From systemDefaults API OR Null which means others)</p>\n</li>\n<li><p>service_id: Integer, Optional (from systemDefaults API)</p>\n</li>\n<li><p>importance: 0 to 3 (0: Low, 1: Normal, 2: High, 3: Critical)</p>\n</li>\n<li><p>attachements[]: Array of files, Optional</p>\n</li>\n<li><p>custom_fields: Array of objects (from systemDefaults API)</p>\n<ul>\n<li><p>id: Integer, Required (from systemDefaults API)</p>\n</li>\n<li><p>value: String</p>\n</li>\n</ul>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","external","tickets"],"host":["{{SYSTEM_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a0eaac44-2e14-4933-9db8-1f1628e3f4f3"},{"name":"Update ticket","id":"747d9272-5383-4288-9c0b-95df220a829f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{YOUR_API_KEY}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"_method","value":"PUT","type":"text"},{"key":"content","value":"","type":"text"},{"key":"satisfaction","value":"","type":"text"},{"key":"ticket_status","value":"","type":"text"},{"key":"attachements","type":"file","value":null}]},"url":"https://{{SYSTEM_URL}}/api/external/tickets/:id","description":"<p>When you need to update a ticket of customers, use the API below. Please note that behavior of this API consider your sent values to take actions.</p>\n<ul>\n<li><p>If you just send the content, a simple reply will be set on the ticket.</p>\n</li>\n<li><p>If you send the content with status 4, it means you want to set a reply on ticket and making it closed.</p>\n</li>\n<li><p>If you just send the status as 4 with no content, it means you are going to close the ticket only.</p>\n</li>\n<li><p>If you need to set a satisfaction on a ticket, send the desired value as 1 to 5 which 5 is the highest score.</p>\n</li>\n</ul>\n<p>Header <code>Content-Type</code> in this API should be set as <code>multipart/form-data</code> if you need to send attachments for replies, otherwise, set<code>application/json</code> as <code>Content-Type</code> header.</p>\n<h5 id=\"inputs\">Inputs</h5>\n<ul>\n<li><p>user_id: Integer, Optional</p>\n</li>\n<li><p>user_email, String, Optional</p>\n</li>\n<li><p>user_mobile: String, Optional</p>\n</li>\n<li><p>user_username, String, Optional</p>\n</li>\n<li><p>_method: String, required (Should be set as <code>PUT</code> string)</p>\n</li>\n<li><p>content: String, optional</p>\n</li>\n<li><p>satisfaction: Integer, optional (1 to 5)</p>\n</li>\n<li><p>ticket_status: Integer, optional (only 4 is acceptable)</p>\n</li>\n<li><p>attachements: Array of files, Optional</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","external","tickets",":id"],"host":["{{SYSTEM_URL}}"],"query":[],"variable":[{"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"747d9272-5383-4288-9c0b-95df220a829f"}],"id":"42ba3932-3332-4973-b94a-8470281aed39","description":"<p>It's time to work on customers' tickets. You can do everything which your customers need to manage their tickets.</p>\n<p>Note: For all APIs here, you have to send one of the inputs below, as well as other described inputs.</p>\n<ul>\n<li>user_id</li>\n<li>user_email</li>\n<li>user_mobile</li>\n<li>user_username</li>\n</ul>\n","_postman_id":"42ba3932-3332-4973-b94a-8470281aed39"},{"name":"System APIs","item":[{"name":"System settings","id":"8c49e0ad-03dc-4439-9df5-2c54fcaddc88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{YOUR_API_KEY}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://{{SYSTEM_URL}}/api/external/systemDefaults","description":"<p>This is one of the most practical items for you while using Helpical G2 APIs. It contains the basic settings applied on the software.</p>\n<p>If you would like to retrieve all system settings, just call this API with no more action. Otherwise, if you need to fetch a specific setting, put it as a query parameter in URL.</p>\n<p>Example value: <code>https://{{url}}/api/external/systemDefaults/?departments=1&amp;branches=1</code></p>\n<p>The list of available sub-settings/outputs are:</p>\n<ul>\n<li><p>ticket_categories</p>\n</li>\n<li><p>customer_levels</p>\n</li>\n<li><p>organizations</p>\n</li>\n<li><p>departments</p>\n</li>\n<li><p>custom_fields</p>\n</li>\n<li><p>attachments_maximum_size</p>\n</li>\n<li><p>attachments_allowed_types</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","external","systemDefaults"],"host":["{{SYSTEM_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8c49e0ad-03dc-4439-9df5-2c54fcaddc88"},{"name":"VoIP popup","id":"c83ce30e-7093-4292-803e-b80b37d16484","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{YOUR_API_KEY}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"event\":\"Ring\",\r\n    \"caller_id\":\"02191015848\",\r\n    \"callee_id\":\"201\",\r\n    \"call_id\":\"1682416722.774\",\r\n    \"date\":\"2023/4/25 14:29:15\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{SYSTEM_URL}}/api/external/voipEvent","description":"<p>Calling this API leads to appearing new VoIP call popup on Helpical for employees.</p>\n<p>Note: VoIP add-on secret key should be sent in <code>x-api-key</code> header.</p>\n<p><strong>INPUTS:</strong></p>\n<ul>\n<li><p>event: String, Required (Ring, Answer, Hangup)</p>\n</li>\n<li><p>caller_id: String, Required (Caller phone number)</p>\n</li>\n<li><p>callee_id: String, Required (Callee extension number)</p>\n</li>\n<li><p>call_id: String, Required (Call unique ID)</p>\n</li>\n<li><p>Date: Datetime, Optional</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","external","voipEvent"],"host":["{{SYSTEM_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c83ce30e-7093-4292-803e-b80b37d16484"}],"id":"c073c326-34c9-48d6-b1c8-813e058203b6","description":"<p>And finally, the system APIs which lets you retrieve system fundamental settings or work with Helpical add-ons.</p>\n","_postman_id":"c073c326-34c9-48d6-b1c8-813e058203b6"}],"event":[{"listen":"prerequest","script":{"id":"4f966d60-008c-4c6b-810e-40410fe0a81b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"92baf298-11c1-4a22-bf3b-d49b93755424","type":"text/javascript","exec":[""]}}],"variable":[{"key":"{{SYSTEM_URL}}","value":"SYSTEM_URL"},{"key":"{{YOUR_API_KEY}}","value":"YOUR_API_KEY"}]}