# APP

### **Create APP**

Creating an application with ZBrain Builder is a streamlined process enabled by the platform's intuitive API. To create an app using ZBrain Builder, initiate a POST request to the provided URL with the necessary headers and payload. This includes setting your app's configuration, description, email, knowledge base, and name.

* Request URL: **<https://api.zbrain.ai/contentms/api/manage-app>**
* Request Method: **POST**
* Request Headers:
  1. Authorization: Bearer <\<API Key>>
  2. Content-Type: application/json
* Request Payload:&#x20;
  1. configuration: {type: <<"PUBLIC" or "PRIVATE">>}
  2. description:  << "some description optional" >>
  3. email:   << email >>
  4. knowledgeBases: << Array of KnowledgeBaseId's which are strings >>
  5. name: \<Enter your app name>

<table><thead><tr><th width="193">Parameters</th><th> </th></tr></thead><tbody><tr><td><code>Authorization</code></td><td>Bearer API-Key (get it from settings > profile from <a href="https://app.zbrain.ai/settings/profile">https://app.zbrain.ai/settings/profile</a> )</td></tr><tr><td><code>configuration</code></td><td>type of app i.e., PUBLIC or PRIVATE</td></tr><tr><td><code>description</code></td><td>description about the app</td></tr><tr><td><code>email</code></td><td>registered email id of application creator <code>email</code> ( for PRIVATE app only)</td></tr><tr><td><code>name</code></td><td>name of the app</td></tr><tr><td><code>knowledgeBases</code></td><td>Array of KnowledgeBaseId's which are strings (get the <code>_id</code>  key of each knowledge base from <a href="../../knowledge-base#get-knowledge-bases">Get knowledge bases</a> response)</td></tr></tbody></table>

* Sample request body payload:

  ```json
  {
      "configuration": {"type": "PUBLIC"},
      "description": "App Description",
      "email": "", 
      "knowledgeBases": ["knowledgeBaseId"], 
      "name": "App Name",
  }
  ```
* Code snippets:

{% tabs %}
{% tab title="Node Js" %}

```javascript
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://api.zbrain.ai/contentms/api/manage-app',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <API key>'
  },
  body: JSON.stringify({
    "configuration": {
      "type": "<PUBLIC or PRIVATE>"
    },
    "description": "<some description optional>",
    "email": "<email>",
    "knowledgeBases": [
      "<knowledgeBaseId>",
      "<knowledgeBaseId>"
    ],
    "name": "<name>"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

```

{% endtab %}

{% tab title="Python" %}

```python
import requests
import json

url = "https://api.zbrain.ai/contentms/api/manage-app"

payload = json.dumps({
  "configuration": {
    "type": "<PUBLIC or PRIVATE>"
  },
  "description": "<some description optional>",
  "email": "<email>",
  "knowledgeBases": [
    "<knowledgeBaseId>",
    "<knowledgeBaseId>"
  ],
  "name": "<name>"
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer <API key>'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

```

{% endtab %}

{% tab title="cURL" %}

```
curl --location 'https://api.zbrain.ai/contentms/api/manage-app' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API key>' \
--data '{
    "configuration": {
        "type": "<PUBLIC or PRIVATE>"
    },
    "description": "<some description optional>",
    "email": "<email>",
    "knowledgeBases": [
        "<knowledgeBaseId>",
        "<knowledgeBaseId>"
    ],
    "name": "<name>"
}'
```

{% endtab %}
{% endtabs %}

* Sample Response:

  ```json
  {
      "responseData": {
          "styles": {
              "headerColor": "string",
              "textColor": "string",
              "sideBarColor": "string",
              "sideBarText": "string",
              "backGroundColor": "string",
              "sampleQueryColor": "string",
              "botReplyBg": "string"
          },
          "configuration": {
              "id": number,
              "type": "string"
          },
          "logo": "string",
          "name": "string",
          "description": "string",
          "pageTitle": "string",
          "pageDescription": "string",
          "botName": "string",
          "botInstruction": "string",
          "botIcon": "string",
          "botType": "string",
          "model": "string",
          "tenantId": "string",
          "email": "string",
          "createdBy": "string",
          "knowledgeBases": [
              "string"
          ],
          "sampleQueries": ["string"],
          "suggestedQueries": ["string"],
          "_id": "string",
          "addedOn": number,
          "modifiedOn": number
      },
      "message": "App created successfully",
      "success": true,
      "responseCode": 200
  }
  ```

### Get all APPs

The ZBrain get app API allows users to get all the user's active apps. To get a ZBrain app, initiate a GET request to the provided URL with the necessary payload.

* Request URL: **<https://api.zbrain.ai/contentms/api/apps?skip=0\\&limit=10>**
* Request Method: **GET**
* Query strings:&#x20;
  1. skip: << numeric value >>
  2. limit: << numeric value >>
* Request Headers:
  1. Authorization: Bearer <\<API Key >>&#x20;
  2. Content-Type: application/json

<table><thead><tr><th width="205">Parameters</th><th> </th></tr></thead><tbody><tr><td><code>Authorization</code></td><td>Bearer API-Key (get it from settings > profile from <a href="https://app.zbrain.ai/settings/profile">https://app.zbrain.ai/settings/profile</a> )</td></tr><tr><td><code>skip</code></td><td>no.of apps to skip</td></tr><tr><td><code>limit</code></td><td>no.of apps to listout</td></tr></tbody></table>

* Sample Query string:

```
?skip=0&limit=10
```

* Code snippets:

{% tabs %}
{% tab title="Node Js" %}

```javascript
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://api.zbrain.ai/contentms/api/apps?skip=0&limit=10',
  'headers': {
    'Authorization': 'Bearer <API key>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

```

{% endtab %}

{% tab title="Python" %}

```python
import requests

url = "https://api.zbrain.ai/contentms/api/apps?skip=0&limit=10"

payload = {}
headers = {
  'Authorization': 'Bearer <API key>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

```

{% endtab %}

{% tab title="cURL" %}

```
curl --location 'https://api.zbrain.ai/contentms/api/apps?skip=0&limit=10' \
--header 'Authorization: Bearer <API key>'
```

{% endtab %}
{% endtabs %}

* Sample Response:

  ```json
  {
      "responseData": {
          "data": [
              {
                  "name": "string",
                  "createdByName": "string",
                  "_id": "string",
                  "configuration": {
                      "type": "string"
                  },
                  "createdBy": "string",
                  "isDeactivated": boolean,
                  "role": "string",
                  "addedOn": number,
                  "modifiedOn": number
              }
          ],
          "total": number
      },
      "message": "Information fetched successfully",
      "success": true,
      "responseCode": 200
  }
  ```

### Get APP by ID

* Request URL: **<https://api.zbrain.ai/contentms/api/manage-app/\\><appId>**
* Request Method: **GET**
* Path parameters:
  1. appId: << appId >>
* Request Headers:
  1. Authorization: Bearer <\<API Key >>&#x20;
  2. Content-Type: application/json

<table><thead><tr><th width="218">Parameters</th><th> </th></tr></thead><tbody><tr><td><code>Authorization</code></td><td>Bearer API-Key (get it from settings > profile from <a href="https://app.zbrain.ai/settings/profile">https://app.zbrain.ai/settings/profile</a> )</td></tr><tr><td><code>appId</code></td><td>unique id of app  (_id  get it from the <a href="#get-all-apps">get all APP's</a> api response)</td></tr></tbody></table>

* Sample Path parameters:

```
/manage-app/<appId>
```

* Code snippets:

{% tabs %}
{% tab title="Node Js" %}

```javascript
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://api.zbrain.ai/contentms/api/manage-app/<appId>',
  'headers': {
    'Authorization': 'Bearer <API key>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

```

{% endtab %}

{% tab title="Python" %}

```python
import requests

url = "https://api.zbrain.ai/contentms/api/manage-app/<appId>"

payload = {}
headers = {
  'Authorization': 'Bearer <API key>'
}var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://app.zbrain.ai:3000/api/manage-app/<appId>',
  'headers': {
    'Authorization': 'Bearer <API key>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});


response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

```

{% endtab %}

{% tab title="cURL" %}

```
curl --location 'https://api.zbrain.ai/contentms/api/manage-app/<appId>' \
--header 'Authorization: Bearer <API key>'
```

{% endtab %}
{% endtabs %}

* Sample Response:

  ```json
  {
      "responseData": {
          "styles": {
              "headerColor": "string",
              "textColor": "string",
              "sideBarColor": "string",
              "sideBarText": "string",
              "backGroundColor": "string",
              "sampleQueryColor": "string",
              "botReplyBg": "string"
          },
          "configuration": {
              "id": number,
              "type": "string"
          },
          "logo": "string",
          "name": "string",
          "description": "string",
          "pageTitle": "string",
          "pageDescription": "string",
          "botName": "string",
          "botInstruction": "string",
          "botIcon": "string",
          "botType": "string",
          "model": "string",
          "tenantId": "string",
          "email": "string",
          "createdBy": "string",
          "knowledgeBases": [
              "string"
          ],
          "sampleQueries": ["string"],
          "suggestedQueries": ["string"],
          "_id": "string",
          "addedOn": number,
          "modifiedOn": number
      },
      "message": "Information fetched successfully",
      "success": true,
      "responseCode": 200
  }
  ```

### Update APP

The ZBrain app update API allows for various modifications to your existing application. This includes the ability to change your app's name, add or adjust sample queries, modify the title and description of the chat page, alter the chatbot's instructions, or even rename the app. Additionally, it provides the flexibility to update the knowledge bases linked to your application. To update a ZBrain app, initiate a PUT request to the provided URL with the necessary payload.

* Request URL: **<https://api.zbrain.ai/contentms/api/manage-app>**
* Request Method: **PUT**
* Request Payload:
  1. name : << App name >>
  2. sampleQueries : << Array of questions >>
  3. pageTitle: << Chat screen tttle >>
  4. pageDescription: << Chat screen description >>
  5. appId: << appId>>
  6. knowledgeBases: << Array of knowledgebaseId's >>
  7. botInstruction: << Instruction to chatbot >>
  8. botName: << chatbot name >>

<table><thead><tr><th width="214"></th><th> </th></tr></thead><tbody><tr><td><code>Authorization</code></td><td>Bearer API-Key (get it from settings > profile from <a href="https://app.zbrain.ai/settings/profile">https://app.zbrain.ai/settings/profile</a> )</td></tr><tr><td><code>name</code></td><td>name of the app</td></tr><tr><td><code>sampleQueries</code></td><td>sample queries for chatscreen </td></tr><tr><td><code>appId</code></td><td>unique id of app  (_id  get it from the <a href="#get-all-apps">get all APP's</a> api response)</td></tr><tr><td><code>pageTitle</code></td><td>name to the chat screen</td></tr><tr><td><code>pageDescription</code></td><td>description to the chatscreen</td></tr><tr><td><code>knowledgeBases</code></td><td>Array of KnowledgeBaseId's which are strings (get the <code>_id</code>  key of each knowledge base from <a href="../../knowledge-base#get-knowledge-bases">Get knowledge bases</a> response)</td></tr><tr><td><code>botInstruction</code></td><td>instruction to bot</td></tr><tr><td><code>botName</code></td><td>bot name</td></tr></tbody></table>

* Sample request body payload:&#x20;

```json
{
    "name": "name of app",
    "sampleQueries": ["sample query 1","sample query 2"],
    "appId": "_id", 
    "pageTitle": "chat screen title", 
    "pageDescription": "chat screen description",
    "knowledgeBases": ["knowledgeBase1_id","knowledgeBase2_id"]
    "botInstruction": "bot instruction",
    "botName": "bot name"
}
```

* Code snippets:

{% tabs %}
{% tab title="Node Js" %}

```javascript
var request = require('request');
var options = {
  'method': 'PUT',
  'url': 'https://api.zbrain.ai/contentms/api/manage-app',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <API key>'
  },
  body: JSON.stringify({
    "name": "<name>",
    "sampleQueries": [
      "<add sample queries>"
    ],
    "pageTitle": "<pageTitle>",
    "pageDescription": "<pageDescription>",
    "appId": "<appId>",
    "knowledgeBases": [
      "knowledgeBaseId",
      "knowledgeBaseId"
    ],
    "botInstruction": "<instruction to bot>",
    "botName": "<bot name>"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

```

{% endtab %}

{% tab title="Python" %}

```python
import requests
import json

url = "https://api.zbrain.ai/contentms/api/manage-app"

payload = json.dumps({
  "name": "<name>",
  "sampleQueries": [
    "<add sample queries>"
  ],
  "pageTitle": "<pageTitle>",
  "pageDescription": "<pageDescription>",
  "appId": "<appId>",
  "knowledgeBases": [
    "knowledgeBaseId",
    "knowledgeBaseId"
  ],
  "botInstruction": "<instruction to bot>",
  "botName": "<bot name>"
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer <API key>'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

```

{% endtab %}

{% tab title="cURL" %}

```
curl --location --request PUT 'https://api.zbrain.ai/contentms/api/manage-app' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API key>' \
--data '{
    "name": "<name>",
    "sampleQueries": [
        "<add sample queries>"
    ],
    "pageTitle": "<pageTitle>",
    "pageDescription": "<pageDescription>",
    "appId": "<appId>",
    "knowledgeBases": [
        "knowledgeBaseId",
        "knowledgeBaseId"
    ],
    "botInstruction": "<instruction to bot>",
    "botName": "<bot name>"
}'
```

{% endtab %}
{% endtabs %}

* Sample Response:

  ```json
  {
      "responseData": {
          "styles": {
              "headerColor": "string",
              "textColor": "string",
              "sideBarColor": "string",
              "sideBarText": "string",
              "backGroundColor": "string",
              "sampleQueryColor": "string",
              "botReplyBg": "string"
          },
          "configuration": {
              "id": number,
              "type": "string"
          },
          "logo": "string",
          "name": "string",
          "description": "string",
          "pageTitle": "string",
          "pageDescription": "string",
          "botName": "string",
          "botInstruction": "string",
          "botIcon": "string",
          "botType": "string",
          "model": "string",
          "tenantId": "string",
          "email": "string",
          "createdBy": "string",
          "knowledgeBases": [
              "string"
          ],
          "sampleQueries": ["string"],
          "suggestedQueries": ["string"],
          "_id": "string",
          "addedOn": number,
          "modifiedOn": number
      },
      "message": "Information added successfully",
      "success": true,
      "responseCode": 200
  }
  ```

### Delete APP

To delete an app on ZBrain Builder, simply send a DELETE request to the provided URL, replacing '' with your specific application's ID. Ensure the required headers, including your Authorization Bearer and Content-Type, are correctly included in the request.

* Request URL: **<https://api.zbrain.ai/contentms/api/delete-app/\\><appId>**
* Request Method: **DELETE**
* Request Headers:
  1. Authorization: Bearer <\<API Key>>&#x20;
  2. Content-Type: application/json

<table><thead><tr><th width="235"></th><th> </th></tr></thead><tbody><tr><td><code>Authorization</code></td><td>Bearer API-Key (get it from settings > profile from <a href="https://app.zbrain.ai/settings/profile">https://app.zbrain.ai/settings/profile</a> )</td></tr><tr><td><code>appId</code></td><td>unique id of app  (_id  get it from the <a href="#get-all-apps">get all APP's</a> api response)</td></tr></tbody></table>

* Sample Request Path Payload:<br>

  ```
  /appId
  ```
* Code snippets:

{% tabs %}
{% tab title="Node Js" %}

```javascript
var request = require('request');
var options = {
  'method': 'DELETE',
  'url': 'https://api.zbrain.ai/contentms/api/delete-app/<appId>',
  'headers': {
    'Authorization': 'Bearer <API key>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

```

{% endtab %}

{% tab title="Python" %}

```python
import requests

url = "https://api.zbrain.ai/contentms/api/delete-app/<appId>"

payload = {}
headers = {
  'Authorization': 'Bearer <API key>'
}

response = requests.request("DELETE", url, headers=headers, data=payload)

print(response.text)
```

{% endtab %}

{% tab title="cURL" %}

```
curl --location --request DELETE 'https://api.zbrain.ai/contentms/api/delete-app/<appId>' \
--header 'Authorization: Bearer <API key>'
```

{% endtab %}
{% endtabs %}

* Sample Response:

  ```json
  {
      "responseData": "App deleted successfully",
      "message": "App deleted successfully",
      "success": true,
      "responseCode": 200
  }
  ```

### **Query APP**

ZBrain Builder's query  API responds to user queries in a real-time streaming format. By initiating a POST request with the specific app ID and query, the API facilitates a continuous, interactive conversation with the user, enhancing the chatbot experience.

* Request URL: **<https://api.zbrain.ai/queryenginems/api/chat/generate>**
* Request Method: **POST**
* Request Headers:
  1. Authorization: Bearer <\<API Key>>&#x20;
  2. Content-Type: application/json
* Sample request body:

{% code lineNumbers="true" %}

```json
{
  "appId": "",
  "conversationId": "",
  "query": "",
  "stream": false,
  "tenantId": "",
  "chatUser": {
    "name": "",
    "email": "",
    "phoneNumber": ""
  }
}
```

{% endcode %}

* Code snippets:&#x20;

{% tabs %}
{% tab title="Node Js" %}

```javascript
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://api.zbrain.ai/queryenginems/api/chat/generate',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <API key>'
  },
  body: JSON.stringify({
    "appId": "",
    "query": "",
    "tenantId": "",
    "stream": false,
    "chatUser": {
        "name": "",
        "email": "",
        "phoneNumber": "",
        "chatUserId": ""
    },
    "conversationId": ""
})

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
```

{% endtab %}

{% tab title="Python" %}

```python
import requests
import json

url = "https://api.zbrain.ai/queryenginems/api/chat/generate"

payload = json.dumps({
  "appId": "",
  "query": "",
  "tenantId": "",
  "stream": ,
  "chatUser": {
    "name": "",
    "email": "",
    "phoneNumber": "",
    "chatUserId": ""
  },
  "conversationId": ""
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer <API-key>'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

```

{% endtab %}

{% tab title="cURL" %}

```
curl --location 'https://api.zbrain.ai/queryenginems/api/chat/generate' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API-key>' \
--data-raw '{
    "appId": "",
    "query": "",
    "tenantId": "",
    "stream": ,
    "chatUser": {
        "name": "",
        "email": "",
        "phoneNumber": "",
        "chatUserId": ""
    },
    "conversationId": ""
}'
```

{% endtab %}
{% endtabs %}

### **Get APP analytics** <a href="#get-app-analytics" id="get-app-analytics"></a>

To retrieve application analytics, send a GET request to the specified URL with the required parameters. Ensure the request includes the relevant application ID and tenant ID, and confirm that the necessary headers are correctly incorporated.

* Request: **<https://api.zbrain.ai/contentms/v2/api/app-analytics>**
* Request Method: GET
* Query Strings:\
  tenantId: <\<Enter the ID of the tenant>>\
  appId : <\<Enter the ID of the app>>\
  startTimestamp: << Enter the start timestamp for the analytics data>>\
  endTimestamp: <\<Enter the end timestamp for the analytics data>>
* Request headers:\
  "Authorization": "Bearer \<your\_access\_token>"\
  "Content-Type": "application/json"
* Sample Request Query Parameters:

```
{
    "tenantId": "",
    "appId": "",
    "startTimestamp": "",
    "endTimestamp": ""
}
```

* **Sample Response:**

```
{
    "responseData": {
        "sessions": [
            {
                "x": "2024-04-25",
                "y": 1
            },
            {
                "x": "2024-04-26",
                "y": 1
            }
        ],
        "queries": [
            {
                "x": "2024-04-26",
                "y": 1
            },
            {
                "x": "2024-04-25",
                "y": 2
            }
        ],
        "tokenUsage": [
            {
                "x": "2024-04-26",
                "y": 27
            },
            {
                "x": "2024-04-25",
                "y": 100
            }
        ]
    },
    "message": "Information fetched successfully",
    "success": true,
    "responseCode": 200
}
```

### **Get APP reports** <a href="#get-app-reports" id="get-app-reports"></a>

To obtain app reports, send a GET request to the following URL with the specified query parameters. Required query parameters include the tenant ID and app ID. Optional query parameters include email, searchQuery, startDate, and endDate.

* Request URL: **<https://api.zbrain.ai/contentms/v2/api/app-reports>**
* Request Method: GET
* Query String:\
  tenantId (string, required): <\<Enter the ID of the tenant>>\
  appId (string, required):<\<Enter ID of the application>>\
  email (string, optional): <\<Enter the email of the user for filtering>>\
  searchQuery (string, optional): <\<Enter the search query>>\
  startDate (timestamp, optional): << Enter the start date for filtering sessions>>\
  endDate (timestamp, optional): <\<Enter the end date for filtering sessions>>
* Request Headers:\
  Authorization: Bearer \<your\_access\_token>\
  Content-Type: application/json
* Sample Request Query Parameters:

```
{
  "tenantId": "",
  "appId": "",
  "email": "",
  "searchQuery": "",
  "startDate":,
  "endDate":
}
```

* Sample Response:

```
{
    "responseData": {
        "sessions": [
            {
                "_id": "session_id_1",
                "appId": "example_app_id",
                "queriesCount": 2,
                "tokenUsed": 12684,
                "user": null,
                "sessionStart": 1718082947067,
                "sessionEnd": 1718082933015,
                "timeTaken": 0,
                "likes": 0,
                "dislikes": 0,
                "averageTimeTaken": 0,
                "satisfactionScore": null
            },
            {
                "_id": "session_id_2",
                "appId": "example_app_id",
                "queriesCount": 3,
                "tokenUsed": 122,
                "user": {
                    "name": "",
                    "email": "",
                    "phoneNumber": "",
                    "chatUserId": ""
                },
                "sessionStart": 1717407595038,
                "sessionEnd": 1717407037654,
                "timeTaken": 0,
                "likes": 0,
                "dislikes": 0,
                "averageTimeTaken": 0,
                "satisfactionScore": null
            }
        ],
        "totals": {
            "totalSessions": 2,
            "totalQueriesCount": 15,
            "totalTokenUsed": 12806,
            "totalTimeTaken": 0,
            "totalLikes": 0,
            "totalDislikes": 0,
            "averageTimeTaken": 0,
            "satisfactionScore": null
        }
    },
    "message": "Information fetched successfully",
    "success": true,
    "responseCode": 200
}
```

### **Get filter options for the APP reports** <a href="#get-filter-options-for-the-app-reports" id="get-filter-options-for-the-app-reports"></a>

To fetch app report filter options, send a GET request to the following URL with the specified parameters. These parameters specify the context for filtering options tailored to specific tenants, applications, and user emails. Ensure the request includes appropriate headers and any necessary authentication headers if the endpoint requires authentication.

* Request URL: **<https://api.zbrain.ai/contentms/v2/api/app-reports/filter>**
* Request Method: GET
* Query String:\
  tenantId: <\<Enter the ID of the tenant>>\
  appId: <\<Enter the application's ID>>\
  email: <\<Enter the user's email address>>
* Request Headers:\
  Authorization: Bearer \<your\_access\_token>\
  Content-Type: application/json
* Sample Request Query Parameters:

```
{
  "tenantId": "",
  "appId": "",
  "email": ""
}
```

* Sample Response:

```
{
    "responseData": {
        "users": {
            "name": "John Doe",
            "email": "johndoe@example.com",
            "phoneNumber": "+1234567890",
            "chatUserId": "chat123"
        }
    },
    "message": "Information fetched successfully",
    "success": true,
    "responseCode": 200
}
```