Viewing group list
- Print
- PDF
Viewing group list
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
You can view a group list.
Requests
- GET /groups
Request parameters
| Parameters | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| searchColumn | N | String | groupName, groupNrn, groupId | - Search column groupName, groupNrn, groupId |
| searchWord | N | String | Search keyword | |
| page | N | int | - Page number Default: 0 | |
| size | N | int | - Number of results Default: 20 |
Responses
Response bodies
{
"page" : "integer",
"totalPages" : "integer",
"totalItems" : "integer",
"hasPrevious" : "boolean",
"hasNext" : "boolean",
"items" : [ {
"groupId":"String",
"groupName":"String",
"nrn":"String",
"createdAt":"String",
"updatedAt":"String",
"description":"String"
}
],
"isFirst" : "boolean",
"isLast" : "boolean"
}
| Parameters | Type | Description | Restrictions |
|---|---|---|---|
| page | Number | Page of the returned result (required) | |
| totalPages | Number | totalPage of the returned result (required) | |
| totalItems | Number | totalItems of the returned result (required) | |
| hasPrevious | Boolean | Whether the current page has a previous page (required) | |
| hasNext | Boolean | Whether the current page has a next page (required) | |
| isFirst | Boolean | Whether the current page is the first page (required) | |
| isLast | Boolean | Whether the current page is the last page (required) | |
| items.[].groupId | String | Group ID (UUID) | |
| items.[].groupName | String | Group name | |
| items.[].nrn | String | Group nrn | |
| items.[].description | String | Group description | |
| items.[].createdAt | String | Creation time (UTC, e.g., 2023-04-25T13:11:50Z) | |
| items.[].updatedAt | String | Edit time (UTC, e.g., 2023-04-25T13:11:50Z) |
Errors
Errors that may occur while using this action are listed below. For error response format, see ErrorResponse.
For more information on common errors, see NAVER Cloud Platform API.
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | Invalid request |
Was this article helpful?