アカウントで利用可能なグループおよびグループメンバーのリストを取得します。
このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [ロール管理] の [ロール管理] の管理APIスコープを必要とします。
GET https://{{host}}/api/public/groups?offset=0&limit=2
パスパラメータ
| パラメータ | 必須/任意 | 説明 |
|---|---|---|
| ホスト | 必須 | 環境URL（例： https://bots.kore.ai） |
| offset | 任意 | グループの記録の取得を開始するページ番号を指定します。指定されていない場合は、グループの記録の最初のページである0から開始されます。 |
| limit | 任意 | 取得する記録数です。最大値は50です。 |
認証
以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}
応答のコンテンツタイプ
application/json
サンプルリクエスト
curl -X GET \ https://{{host}}/api/public/groups?offset=0&limit=2' \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
サンプル応答
{ "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 } ] }