그룹 상세

회사명·사업자번호·담당자까지 그룹 한 곳의 전체 정보를 돌려줘요.

특정 고객 그룹의 상세 정보를 조회해요. 응답 필드는 개인·기업·부서 유형에 따라 달라요.

API 엔드포인트

GEThttps://api.bootapi.com/v1/user-groups/:idBasic Auth

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

요청 파라미터

파라미터	타입	필수	설명
`id`	String	필수	조회할 그룹의 고유 ID (URL 파라미터)

코드 예제

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

const commerce = new BootpayCommerce({
    client_key: '{client_key}',
    secret_key: '{secret_key}'
});

const userGroupId = '67e2052b03d0cb4e4117b0af';
const response = await commerce.userGroup.detail(userGroupId);
console.log(response);javascript

from bootpay_backend.commerce import BootpayCommerce

commerce = BootpayCommerce('{client_key}', '{secret_key}')
user_group_id = '67e2052b03d0cb4e4117b0af'
response = commerce.user_group.detail(user_group_id)
print(response)python

use Bootpay\ServerPhp\BootpayCommerceApi;

$commerce = new BootpayCommerceApi("{client_key}", "{secret_key}");
$userGroupId = '67e2052b03d0cb4e4117b0af';
$response = $commerce->userGroup->detail($userGroupId);
print_r($response);php

import kr.co.bootpay.store.BootpayStore;
import kr.co.bootpay.store.model.request.TokenPayload;

TokenPayload tokenPayload = new TokenPayload("{client_key}", "{secret_key}");
BootpayStore bootpay = new BootpayStore(tokenPayload).withToken();
String userGroupId = "67e2052b03d0cb4e4117b0af";
var response = bootpay.userGroup.detail(userGroupId);
System.out.println(response.getData());java

require 'bootpay'

commerce = BootpayStore::RestClient.new(client_key: '{client_key}', secret_key: '{secret_key}')
user_group_id = '67e2052b03d0cb4e4117b0af'
response = commerce.lookup_user_group(
  user_group_id: user_group_id
)
puts responseruby

commerce := bootpay.NewCommerceApi("{client_key}", "{secret_key}")
userGroupId := "67e2052b03d0cb4e4117b0af"
response, err := commerce.UserGroup.Detail(userGroupId)
fmt.Println(response)go

using Bootpay.Commerce;

var commerce = new BootpayCommerceApi("{client_key}", "{secret_key}");
var userGroupId = "67e2052b03d0cb4e4117b0af";
var response = await commerce.UserGroup.Detail(userGroupId);
Console.WriteLine(response);csharp

응답

성공 응답

{
  "company_name": "부트페이 주식회사",
  "business_number": "1234567890",
  "manager_name": "홍길동",
  "registration_number": "1101111234567",
  "business_type": "서비스",
  "business_category": "소프트웨어",
  "sub_group_type": 1,
  "sub_group_type_label": "부서",
  "sub_group_manager_label": "부서장",
  "use_sub_group": false,
  "use_subscription_aggregate_transaction": false,
  "subscription_month_day": 1,
  "subscription_week_day": 1,
  "use_limit": false,
  "limit_month_purchase": 0.0,
  "limit_week_purchase": 0.0,
  "subscribed_month_limit": 0.0,
  "subscribed_week_limit": 0.0,
  "limit_message": null
}json

기업 그룹 기준 예시예요. 응답에 user_group_id·corporate_type·phone·email·status 는 담기지 않아요. 개인 그룹에는 point·accumulation·pccc, 부서 그룹에는 name·parent_corporate(상위 기업 정보)가 더 붙어요. 연락처와 상태는 그룹 목록에서 확인해요.

그룹 상태 (`status`)

키	값	설명
`active`	`1`	활성
`inactive`	`0`	비활성
`deleted`	`-1`	삭제됨

그룹 유형 (`corporate_type`)

키	유형	설명
`individual`	개인	개인 고객 그룹
`business`	기업	기업 고객 그룹
`department`	부서	기업 내 부서 그룹

에러 코드

인증·권한 관련 에러는 에러 코드표를 참고해요.

코드	메시지	대처 방법
`USER_GROUP_NOT_FOUND`	회원 그룹 정보를 찾지 못했어요. 다시 로그인해요.	user_group_id를 확인해요
`USER_GROUP_NOT_AUTHORIZED`	그룹 정보를 설정할 권한이 없어요.	그룹 관리자 권한이 있는지 확인해요