The Quincy API uses a session based authorization for the interactive elements.
The session end point is where the session key is generated using a POST command.
This session key will be used in the Authorization header for all requests.
The API key is acquired on the admin dashboard
\nGet all Chat Widgets associated with your Group.
\nThe output will be an array of objects in the format of:
\nChat_widget_branding array options:
\n","urlObject":{"path":["chat_widgets"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"7eaf18ce-bb72-4241-aacf-12fb231460b0","name":"Get Chat Widgets","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{session_key}}","type":"text"}],"url":"{{baseUrl}}/chat_widgets"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.9"},{"key":"Date","value":"Tue, 16 Jun 2020 00:22:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"838639f310c5c9c144689d4d0748ad83\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"6daba2be-b466-4a68-ab48-7b0921e84e81"},{"key":"X-Runtime","value":"0.345329"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"Get a Chat Widget's details given an id.\nThe response will contain the details of the chat widget. The chat_widget_id is required in the path.
\nResponse
\nChat_widget_branding array options:
\n","urlObject":{"path":["chat_widgets",":chat_widget_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"032e99f8-115e-48cc-978a-ea33b9294854","description":{"content":"(Required) Chat Widget UUID
\n","type":"text/plain"},"type":"string","value":"{{chat_widget_id}}","key":"chat_widget_id"}]}},"response":[{"id":"c274a461-335e-45d6-a685-94aab21041f4","name":"ChatWidget","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/chat_widgets/:chat_widget_id","host":["{{baseUrl}}"],"path":["chat_widgets",":chat_widget_id"],"variable":[{"key":"chat_widget_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Get The chat widget invitation history.
\nThere are two parameters that may be passed in the url to change the amount of data visible in your report:
\nThe data response is an array of objects and each array has the following parameters:
\n","urlObject":{"path":["chat_widgets",":chat_widget_id","invitation_history"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"a848a275-43aa-4dae-b271-7c0e16df9369","description":{"content":"(Required) Chat Widget UUID
\n","type":"text/plain"},"type":"string","value":"{{chat_widget_id}}","key":"chat_widget_id"}]}},"response":[{"id":"7dc099d2-e12c-4f2f-b9c7-f590f69f021e","name":"Get details of a Chat Widget Copy","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{session_key}}","type":"text"}],"url":{"raw":"{{baseUrl}}/chat_widgets/:chat_widget_id/invitation_history?page=1&per_page=1","host":["{{baseUrl}}"],"path":["chat_widgets",":chat_widget_id","invitation_history"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"1"}],"variable":[{"key":"chat_widget_id","value":"{{chat_widget_id}}","type":"string","description":"(Required) Chat Widget UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Mon, 18 Jan 2021 17:12:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"570779923eb56009fc76067e1845e7a1\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"ee5cb5ec-2dac-4e15-abdd-134ae1b7d195"},{"key":"X-Runtime","value":"0.026995"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"status\": \"The response will contain:
\nChat_widget_branding array options:
\nChat widget webhook_setting options:
\n","urlObject":{"path":["chat_widgets",":chat_widget_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"87dab91f-d242-438f-b320-c1470c5cbfdc","description":{"content":"(Required) Chat Widget UUID
\n","type":"text/plain"},"type":"string","value":"{{chat_widget_id}}","key":"chat_widget_id"}]}},"response":[{"id":"39e66ba9-5924-4c38-bede-6d1b17a54be2","name":"ChatWidget","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Get all Chat Bots associated with your Group.
\nThe output will be an array of objects in the format of:
\n","urlObject":{"path":["bots"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"5eaa7b95-ab53-40f7-ba3f-356d2ef6d816","name":"Get Chat Widgets","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{session_key}}","type":"text"}],"url":{"raw":"{{baseUrl}}/chat_widgets","host":["{{baseUrl}}"],"path":["chat_widgets"],"query":[{"key":"page","value":null,"type":"text","disabled":true},{"key":"per_page","value":null,"type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.9"},{"key":"Date","value":"Tue, 16 Jun 2020 00:22:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"838639f310c5c9c144689d4d0748ad83\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"6daba2be-b466-4a68-ab48-7b0921e84e81"},{"key":"X-Runtime","value":"0.345329"}],"cookie":[],"responseTime":null,"body":" \"data\": [\n {\n \"name\": \"Assign Agent is used to assign an agent to a chat widget. The qliq_id of the agent is required to add this agent to the chat widget.
\nThe response:
\n","urlObject":{"path":["chat_widgets",":chat_widget_id","agents"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"c4f86d9a-8249-4243-9fee-5ccaaf0f88a1","description":{"content":"(Required) Chat Widget UUID
\n","type":"text/plain"},"type":"string","value":"{{chat_widget_id}}","key":"chat_widget_id"}]}},"response":[{"id":"d1749fa9-c800-497e-abb0-634e8d56cc34","name":"A single Agent","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"qliq_id\": \"Get all Agents for this Chat Widget
\nThis response will be an array that contains the agent details:
\n","urlObject":{"path":["chat_widgets",":chat_widget_id","agents"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"315a12c0-cf0c-4b1c-ac1e-422494be0b5c","description":{"content":"(Required) Chat Widget UUID
\n","type":"text/plain"},"type":"string","value":"{{chat_widget_id}}","key":"chat_widget_id"}]}},"response":[{"id":"c6265026-af3e-428d-8315-c9a08beb0bae","name":"An array of Agents","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/chat_widgets/:chat_widget_id/agents","host":["{{baseUrl}}"],"path":["chat_widgets",":chat_widget_id","agents"],"variable":[{"key":"chat_widget_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"email\": \"Get details of an agent for a specific chat widget given a qliq_id. The chat widget uid and agent id are required in the URL.
\nThe response will be the agent details
\n","urlObject":{"path":["chat_widgets",":chat_widget_id","agents",":agent_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"81f82eda-5f27-414f-aafc-9193b2fed0e9","description":{"content":"(Required) Chat Widget UUID
\n","type":"text/plain"},"type":"string","value":"{{chat_widget_id}}","key":"chat_widget_id"},{"id":"530799d7-7a99-4497-a1ed-83e04ea81be4","description":{"content":"(Required) Qliq ID of the user you would like to add to this Chat Widget.
\n","type":"text/plain"},"type":"string","value":"{{qliq_id}}","key":"agent_id"}]}},"response":[{"id":"0543231d-3d5b-4299-bba0-eefc26cec64d","name":"A single Agent","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/chat_widgets/:chat_widget_id/agents/:agent_id","host":["{{baseUrl}}"],"path":["chat_widgets",":chat_widget_id","agents",":agent_id"],"variable":[{"key":"chat_widget_id"},{"key":"agent_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"email\": \"Get all Agents for this Chat Widget
\nThis response will be an array that contains the agent details:
\n","urlObject":{"path":["agents"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"cbdf86ec-8dc5-42d4-9429-7dd86a85e83c","name":"An array of Agents","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/chat_widgets/:chat_widget_id/agents","host":["{{baseUrl}}"],"path":["chat_widgets",":chat_widget_id","agents"],"variable":[{"key":"chat_widget_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"email\": \"Get all Agents for this Chat Widget
\nThis response will be an array that contains the agent details:
\n","urlObject":{"path":["agents",":agent_id","assigned_widgets"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"a9e2a84e-6467-4270-9bfd-adac9a81f799","type":"any","value":"{{qliq_id}}","key":"agent_id"}]}},"response":[{"id":"134bdaa0-a890-40f5-a7ae-61b7fbe455a6","name":"Get Assigned widgets by agent id","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{session_key}}","type":"text"}],"url":{"raw":"{{baseUrl}}/agents/:agent_id/assigned_widgets","host":["{{baseUrl}}"],"path":["agents",":agent_id","assigned_widgets"],"variable":[{"key":"agent_id","value":"{{agent_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.8.1"},{"key":"Date","value":"Thu, 22 Apr 2021 13:00:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"cb2a5bfc2491705dc1524da88aa2d08d\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"0fa8c729-0e9d-4fa7-b2d5-140f5486502d"},{"key":"X-Runtime","value":"0.043752"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"uid\": \"Get all Agents for this Chat Widget
\nThis response will be an array that contains the agent details:
\n","urlObject":{"path":["agents",":agent_id","conversation_history"],"host":["{{baseUrl}}"],"query":[{"disabled":true,"key":"per_page","value":null},{"disabled":true,"key":"page","value":null}],"variable":[{"id":"9b45bdb2-6daa-4886-bc0b-bb6e72155987","type":"any","value":"{{agent_id}}","key":"agent_id"}]}},"response":[{"id":"8dcbc8a8-7a8c-4709-84b3-a811d4e7cd33","name":"Get Assigned widgets by agent id","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{session_key}}","type":"text"}],"url":{"raw":"{{baseUrl}}/agents/:agent_id/assigned_widgets","host":["{{baseUrl}}"],"path":["agents",":agent_id","assigned_widgets"],"variable":[{"key":"agent_id","value":"{{agent_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.8.1"},{"key":"Date","value":"Thu, 22 Apr 2021 13:00:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Content-Encoding","value":"gzip"},{"key":"ETag","value":"W/\"cb2a5bfc2491705dc1524da88aa2d08d\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"0fa8c729-0e9d-4fa7-b2d5-140f5486502d"},{"key":"X-Runtime","value":"0.043752"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"uid\": \"Update an Agent's status.\nThis boolean statement when set to true will set the agent's status as active. The chat_widget_id and qliq id of the agent must be sent in the URL.
\nThe response will be the agent details with the updated status.
\n","urlObject":{"path":["chat_widgets",":chat_widget_id","agents",":agent_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"ec2651f4-d111-446f-a0fa-7f8980dbb37e","description":{"content":"(Required) Chat Widget UUID
\n","type":"text/plain"},"type":"string","value":"{{chat_widget_id}}","key":"chat_widget_id"},{"id":"37762956-5ac1-4946-9b5c-c11fd2f6ec3f","description":{"content":"(Required) Qliq ID of the user you would like to add to this Chat Widget.
\n","type":"text/plain"},"type":"string","value":"{{qliq_id}}","key":"agent_id"}]}},"response":[{"id":"5a288dc2-43b7-4a3c-8079-d27f6a656e93","name":"The updated Agent","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"active\": \"Remove an Agent from this Chat Widget
\nThe response on a successful removal will only be the response code 200 Ok with the body of \"Done\"
\n","urlObject":{"path":["chat_widgets",":chat_widget_id","agents",":agent_id"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Used for DELETE actions: The qliq id of the agent you want to reassign this agent's conversation to. If this parameter is absent, the conversations will be purged from our records.
\n","type":"text/plain"},"key":"reassigned_to_qliq_id","value":"{{reassign_id}}"}],"variable":[{"id":"f1065817-00eb-49d8-84a8-45fdb41c861d","description":{"content":"(Required) Chat Widget UUID
\n","type":"text/plain"},"type":"string","value":"{{chat_widget_id}}","key":"chat_widget_id"},{"id":"70459c3a-11d5-450d-b310-6c7357cae3f2","description":{"content":"(Required) Qliq ID of the user you would like to add to this Chat Widget.
\n","type":"text/plain"},"type":"string","value":"{{qliq_id}}","key":"agent_id"}]}},"response":[{"id":"0243e2ce-1645-4915-acff-85af51c2668c","name":"OK response, success receipt.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/chat_widgets/:chat_widget_id/agents/:agent_id?reassigned_to_qliq_id=Agents are Users who have been assigned to a widget and can initiate conversations with Patients. In order to get a list of Users and manage Users, utilize the User Management API.
\n","_postman_id":"1a690475-5c81-4354-8735-2fcc96626874"},{"name":"Patients","item":[{"name":"Create Patient","id":"f58c20c0-0728-40e5-a347-e97b80c95780","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{session_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Create a Patient
\nThe response will contain the following parameters:
\nResponse is an array of objects and each array has the following parameters:
\n","urlObject":{"path":["patients"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"7356a0cf-3930-4f0b-883f-0e94f53d6db1","name":"Successfully created Patient","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Get details for all the Patients for your group.
\nResponse is an array of objects and each array has the following parameters:
\n","urlObject":{"path":["patients"],"host":["{{baseUrl}}"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"15"}],"variable":[]}},"response":[{"id":"ec46ab05-7926-40ca-8dfe-fef3a77cc46f","name":"An array of Patients.","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/patients"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"uuid\": \"The following patient fields are searched when making a query: first_name, middle_name, last_name, mobile_number, email address, and mrn.
The query is a string up to 255 characters. If the path parameters ends in \"?q=\", then every user from the group will be displayed.
A partial name search can be utilized, however, the search parameters must start with the beginning of the name - EG: For a search on the user named Test - \"?q=Te\" will yield the result of patient details of \"Test\", however, \"?q=est\" will yield 0 results.
A query utilizing any part of a phone number will yield all patient results that contain that number - EG: For the number +19565551937 a query of \"?q=+1956\" will display yield the result of the patient details for +19565551937. Additionally, if a search is performed on \"?q=555\" the results will also contain the patient results of a user with 555 in the phone number.
\nThe results will be displayed in an array with the following parameters:\n\n