Get User Group List
Returns the list of User Groups for the given API key.
Get User Group List
GET
Headers
Name
Type
Description
Api-key
String
Auth-key E.g.- 33223kjhdcscijhb5sdbsdmjsdcbj5
{
"status": true,
"msg": "Success.",
"code": 200,
"data": {
"next_page": 2,
"pages": 2,
"prev_page": null,
"project_id": "620e3ab8dea1d50efec54581",
"groups": [{
"group_id": "63219da797f30b287431c4c5",
"description": "user-group-11",
"users": ["62eb672606f8a0093ab8e3ab", "621e0782aa28db38198093e6"],
"updated_at": "2022-09-14T09:23:51.456",
"created_at": "2022-09-14T09:23:51.456"
}, {
"group_id": "6321749a8ce7db6512aa2340",
"description": null,
"users": null,
"updated_at": "2022-09-14T06:28:42.720",
"created_at": "2022-09-14T06:28:42.720"
}, {
"group_id": "63217315bac5e0257ab02718",
"description": null,
"users": ["62eb672606f8a0093ab8e3ab", "621e0782aa28db38198093e6"],
"updated_at": "2022-09-14T06:22:13.846",
"created_at": "2022-09-14T06:22:13.846"
}, {
"group_id": "6321730d97f30b11ef7f9368",
"description": "user-group-11",
"users": ["62eb672606f8a0093ab8e3ab", "621e0782aa28db38198093e6"],
"updated_at": "2022-09-14T06:22:05.250",
"created_at": "2022-09-14T06:22:05.250"
}, {
"group_id": "632172dc97f30b11bcb54e84",
"description": null,
"users": ["62eb672606f8a0093ab8e3ab", "621e0782aa28db38198093e6"],
"updated_at": "2022-09-14T06:21:16.801",
"created_at": "2022-09-14T06:21:16.801"
}, {
"group_id": "632172cb97f30b11bcb54e80",
"description": "user-group-11",
"users": ["62eb672606f8a0093ab8e3ab", "621e0782aa28db38198093e6"],
"updated_at": "2022-09-14T06:20:59.485",
"created_at": "2022-09-14T06:20:59.485"
}, {
"group_id": "63216b74bac5e022b548abe5",
"description": "update",
"users": ["621e0782aa28db38198093e6"],
"updated_at": "2022-09-14T08:37:47.614",
"created_at": "2022-09-14T05:49:40.642"
}, {
"group_id": "63216b7097f30b0f4d17364e",
"description": "user-group-19",
"users": null,
"updated_at": "2022-09-14T05:49:36.767",
"created_at": "2022-09-14T05:49:36.767"
}, {
"group_id": "63216b6cbb1aa81402094526",
"description": "user-group-17",
"users": null,
"updated_at": "2022-09-14T05:49:32.536",
"created_at": "2022-09-14T05:49:32.536"
}, {
"group_id": "63216b4fbac5e02269cf40db",
"description": "user-group-7",
"users": null,
"updated_at": "2022-09-14T05:49:03.503",
"created_at": "2022-09-14T05:49:03.503"
}]
}
}
Sample Request
curl --location --request GET 'https://api.roam.ai/v1/api/group/?page_number=1' \
--header 'Api-key: 289eb8eb262140629664078bec76d60c'
Last updated