그룹 상세 조회

특정그룹(UserGroup)의 정보를 상세 조회합니다. 기업, 개인 그룹 모두 조회할 수 있습니다.

GET

https://api.bootapi.com/v1/user-groups/:user_group_id

SDK 설치

Server

서버에서 API를 호출하기 위해 Backend SDK를 설치합니다.

SDK 설치 및 설정 방법은 토큰 발급 가이드를 참고하세요.

API 요청

Server

URL 경로에 그룹 ID를 포함하여 GET 요청을 보냅니다.

요청 파라미터

user_group_idstring필수조회할 그룹의 고유 ID (URL 경로에 포함)

응답 처리

Server

성공 시 그룹의 상세 정보가 반환됩니다.

응답 필드

user_group_idstring그룹 고유 ID
company_namestring회사명
business_numberstring사업자 등록번호
corporate_typeinteger그룹 유형 (1: 개인, 2: 기업)
manager_namestring담당자명
phonestring연락처
emailstring이메일
statusinteger상태 (1: 활성)
http_statusintegerHTTP 상태 코드

에러 코드

USER_GROUP_NOT_FOUND

그룹을 찾을 수 없습니다.

user_group_id를 확인하거나 그룹 목록에서 조회하세요.

USER_GROUP_NOT_AUTHORIZED

그룹에 대한 접근 권한이 없습니다.

토큰의 권한을 확인하거나 admin 권한으로 재시도하세요.

ACCESS_TOKEN_INVALID

유효하지 않은 액세스 토큰입니다.

토큰 발급 API를 통해 새로운 토큰을 발급받으세요.

언어

const { BootpayCommerce } = require('@bootpay/backend-js'); const commerce = new BootpayCommerce({    client_key: '{client_key}',    secret_key: '{secret_key}',    mode: 'development' // 또는 'production'}); const userGroupId = '67e2052b03d0cb4e4117b0af';const response = await commerce.userGroup.detail(userGroupId);console.log(response);