1. Home
  2. Kore.ai Conversational Platform
  3. SDKs & APIs
  4. Using Kore.ai APIs
  5. Get Groups API

Get Groups API

To get the list of groups and group members available in the account.

GET https://{{host}}/api/public/groups

Path Parameters

Parameter Required/Optional Description
host Required Environment URL, for example, https://bots.kore.ai
offset Optional Specify the page number from which to start fetching the group records. If unspecified, it starts from 0, which is the first page of the group records.
limit Optional The number of records to fetch. The maximum applicable limit is 50.

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response Content Type

application/json

Sample Request

curl -X GET \

http://{{host}}/api/public/groups \

-H 'auth: YOUR_JWT_ACCESS_TOKEN' \

Sample Response

{
    "total": 2,
    "availableMore": false,
    "groups": [
        {
            "_id": "e-eed8e93a-79ff-523b-9545-4833c2683e86",
            "gN": "Audit",
            "gDesc": "Audit Team",
            "groups": [],
            "users": [
                {
                    "_id": "u-c32243f6-b4ba-5884-9527-a7efb9a0ac9e",
                    "emailId": "sample1@sampleemail.com",
                    "lastName": "Sample1",
                    "firstName": "Sample",
                    "profImage": "profile.png",
                    "profColour": "#ffd700",
                    "activationStatus": "active",
                    "jTitle": "",
                    "orgId": "o-c2419ad3-e160-5bae-af32-6e62f1153a1e"
                },
                {
                    "_id": "u-f2323ccf-b475-59a9-a52b-194698ee0230",
                    "emailId": "sample2@sampleemail.com",
                    "lastName": "Sample2",
                    "firstName": "Sample",
                    "profImage": "profile.png",
                    "profColour": "",
                    "activationStatus": "active",
                    "jTitle": null,
                    "orgId": "o-8f992732-faa8-5191-bab5-db39efc10a9f"
                }
            ],
            "userCount": 2
        },
        {
            "_id": "e-8c91bfc5-8ecd-5707-9c35-7539297e77c9",
            "gN": "RiskManagement",
            "gDesc": "Risk Management Team",
            "groups": [],
            "users": [
                {
                    "_id": "u-0204c8d7-24d4-5ggf-bd73-7c4eaf093b83",
                    "emailId": "sample3@sampleeemail.com",
                    "lastName": "Sample2",
                    "firstName": "Sample",
                    "profImage": "no-avatar",
                    "profColour": "#2e8b57",
                    "activationStatus": "active",
                    "jTitle": "",
                    "orgId": "o-1b67d2f0-4812-5083-8453-55b8f5f9247f"
                },
                {
                    "_id": "u-19ecg162-40cb-5f0c-b594-2ac52211f09b",
                    "emailId": "sample3@sampleemail.com",
                    "lastName": "Sample3",
                    "firstName": "Sample",
                    "profImage": "no-avatar",
                    "profColour": "#ff0000",
                    "activationStatus": "active",
                    "jTitle": null,
                    "orgId": "o-642h0c8a-6e89-5ffe-8tb4-0eacd11c5b41"
                }
            ],
            "userCount": 2
        }
    ]
}

Was this article helpful to you? Yes No