그룹 조회 | Bootpay 커머스 매뉴얼

등록된 그룹 목록을 조회해요. 그룹 ID 로는 검색되지 않아요.

등록된 고객 그룹 목록을 조회해요.

API 엔드포인트

GEThttps://api.bootapi.com/v1/user-groupsBasic Auth

필요 scope: user:user_group_list. Bootpay-Role 헤더로 역할 부분을 바꿀 수 있어요. v1 회원 그룹 API 상세 명세에서 인증과 응답 필드를 확인해요.

요청 파라미터

파라미터	타입	필수	설명
`corporate_type`	Integer	선택	기본 `2`(기업) — 그룹 유형 (`1`: 개인, `2`: 기업, `3`: 부서). 숫자로 보내요 — 문자열을 보내면 결과가 비어요
`keyword`	String	선택	그룹 ID(정확히 일치) 또는 연락처·이메일·기업명·사업자번호·담당자명 등의 검색어
`page`	Integer	선택	페이지 번호 (기본: 1)
`limit`	Integer	선택	페이지당 데이터 수 (기본: 24)

keyword 에 그룹 ID 를 넣으면 정확히 일치하는 그룹을 찾고, 연락처·이메일·기업명·사업자번호·담당자명 등으로도 검색할 수 있어요. 기본 목록은 기업 그룹만 포함하며 삭제된 그룹은 제외해요. 이 API 의 limit 기본값은 24이고 상한 보정이 없으므로 1~100 사이로 보내요.

코드 예제

const { BootpayCommerce } = require('@bootpay/backend-js')

const commerce = new BootpayCommerce({
    client_key: 'your-commerce-client-key',
    secret_key: 'your-commerce-secret-key',
    mode: 'production'
})

const response = await commerce.userGroup.list({
    corporate_type: 2,
    page: 1,
    limit: 20
})
console.log(response)javascript

from bootpay_backend import BootpayCommerce

commerce = BootpayCommerce(
    client_key='your-commerce-client-key',
    secret_key='your-commerce-secret-key',
    mode='production'
)

response = commerce.user_group.list(
    corporate_type=2,
    page=1,
    limit=20
)
print(response)python

use Bootpay\ServerPhp\BootpayCommerceApi;

$commerce = new BootpayCommerceApi("your-commerce-client-key", "your-commerce-secret-key");
$response = $commerce->userGroupList([
    'corporate_type' => 2,
    'page' => 1,
    'limit' => 20
]);
print_r($response);php

import kr.co.bootpay.store.BootpayStore;
import kr.co.bootpay.store.model.request.TokenPayload;
import kr.co.bootpay.store.model.request.userGroup.UserGroupListParams;
import kr.co.bootpay.store.model.response.BootpayStoreResponse;

TokenPayload tp = new TokenPayload("your-commerce-client-key", "your-commerce-secret-key");
BootpayStore commerce = new BootpayStore(tp).withToken();

UserGroupListParams params = new UserGroupListParams();
params.corporateType = 2;
params.page = 1;
params.limit = 20;

BootpayStoreResponse response = commerce.userGroup.list(params);
System.out.println(response);java

require 'bootpay'

commerce = BootpayStore::RestClient.new(client_key: 'your-commerce-client-key', secret_key: 'your-commerce-secret-key')
response = commerce.user_groups(
  corporate_type: 2,
  page: 1,
  limit: 20
)
puts responseruby

commerce := bootpay.NewCommerceApi("your-commerce-client-key", "your-commerce-secret-key")
response, err := commerce.UserGroupList(map[string]interface{}{
    "corporate_type": 2,
    "page":           1,
    "limit":          20,
})
fmt.Println(response)go

using Bootpay.Commerce;

var commerce = new BootpayCommerceApi("your-commerce-client-key", "your-commerce-secret-key");
var response = await commerce.UserGroupList(new {
    corporate_type = 2,
    page = 1,
    limit = 20
});
Console.WriteLine(response);csharp

응답

성공 응답

{
  "count": 1,
  "list": [
    {
      "user_group_id": "67e2052b03d0cb4e4117b0af",
      "company_name": "(주)부트페이",
      "business_number": "1234567890",
      "corporate_type": "business",
      "ceo_name": "홍길동",
      "manager_name": "김철수",
      "phone": "0212345678",
      "email": "company@example.com",
      "status": "active"
    }
  ]
}json

응답 필드 설명

필드	타입	설명
`count`	Integer	총 그룹 수
`list`	Array	그룹 목록
└─ `user_group_id`	String	그룹 고유 ID
└─ `company_name`	String	회사명
└─ `business_number`	String	사업자등록번호
└─ `corporate_type`	String	그룹 유형 (`individual`: 개인, `business`: 기업, `department`: 부서)
└─ `status`	String	상태 (`active`: 활성, `inactive`: 비활성, `deleted`: 삭제됨)

응답의 status 같은 코드값은 정수가 아니라 문자열(enum)로 내려와요. 전체 목록은 커머스 Enum에서 확인해요.