마켓플레이스

그룹 조회

그룹 목록을 모아 거래처 운영 상태를 빠르게 훑어요.

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

API 엔드포인트

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

요청 파라미터

파라미터 타입 필수 설명
corporate_type Integer 선택 그룹 유형 (1: 개인, 2: 기업)
keyword String 선택 검색 키워드 (그룹 ID, 연락처, 이메일)
page Integer 선택 페이지 번호 (기본: 1)
limit Integer 선택 페이지당 데이터 수 (기본: 20)

코드 예제

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

응답

성공 응답

{
  "count": 2,
  "list": [
    {
      "user_group_id": "grp_687a1b2c3d4e5f",
      "company_name": "(주)부트페이",
      "business_number": "1234567890",
      "corporate_type": 2,
      "ceo_name": "홍길동",
      "manager_name": "김철수",
      "phone": "0212345678",
      "email": "company@example.com",
      "status": 1,
      "created_at": "2025-07-01T10:00:00Z"
    }
  ]
}json

응답 필드 설명

필드 타입 설명
count Integer 총 그룹 수
list Array 그룹 목록
list[].user_group_id String 그룹 고유 ID
list[].company_name String 회사명
list[].business_number String 사업자등록번호
list[].corporate_type Integer 그룹 유형 (1: 개인, 2: 기업)
list[].status Integer 상태 (1: 활성)