계정에서 사용할 수 있는 그룹 및 그룹 구성원 목록을 가져옵니다.
이 API를 사용하려면 오직 봇 관리자 콘솔에서 생성된 애플리케이션에서 만들어진 JWT가 필요합니다. 이 API를 사용하려면 앱은 역할 관리 아래에 있는 역할 관리의 관리자 API 범위가 필요합니다.
GET https://{{host}}/api/public/groups?offset=0&limit=2
경로 매개 변수
| 매개 변수 | 필수/선택 사항 | 설명 |
|---|---|---|
| host | 필수 | 환경 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
}
]
}