MENU
      Viewing group list

        Viewing group list


        Article summary

        You can view a group list.

        Requests

        • GET /groups

        Request parameters

        ParametersRequirement statusTypeRestrictionsDescription
        searchColumnNStringgroupName, groupNrn, groupId- Search column
        groupName, groupNrn, groupId
        searchWordNStringSearch keyword
        pageNint- Page number
        Default: 0
        sizeNint- 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"
        }
        JSON
        ParametersTypeDescriptionRestrictions
        pageNumberPage of the returned result (required)
        totalPagesNumbertotalPage of the returned result (required)
        totalItemsNumbertotalItems of the returned result (required)
        hasPreviousBooleanWhether the current page has a previous page (required)
        hasNextBooleanWhether the current page has a next page (required)
        isFirstBooleanWhether the current page is the first page (required)
        isLastBooleanWhether the current page is the last page (required)
        items.[].groupIdStringGroup ID (UUID)
        items.[].groupNameStringGroup name
        items.[].nrnStringGroup nrn
        items.[].descriptionStringGroup description
        items.[].createdAtStringCreation time (UTC, e.g., 2023-04-25T13:11:50Z)
        items.[].updatedAtStringEdit 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 codeError codeError message
        400Invalid request

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.