그룹 목록 조회

조건에 맞는그룹(UserGroup)목록을 조회합니다. 기업, 개인 그룹 모두 조회할 수 있습니다.

그룹 유형 설명

  • 기업 그룹 - 동일 기업 소속의 여러 사용자를 하나의 그룹으로 묶어, 구독 계약과 결제 내역을 통합 관리할 수 있습니다.
  • 개인 그룹 - 회원 가입 시 자동으로 만들어지며, 기업 소속으로 가입한 경우에도 개인 그룹은 별도로 생성됩니다.
GET
https://api.bootapi.com/v1/user-groups
1
SDK 설치
Server

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

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

검색 조건을 설정하여 그룹 목록을 조회합니다.

요청 파라미터
  • corporate_typeinteger그룹 유형 (1: 개인, 2: 기업)
  • keywordstring검색 키워드 (그룹ID, 연락처, 이메일 등)
  • pageinteger페이지 번호 (기본값: 1)
  • limitinteger페이지당 데이터 수 (기본값: 20)
3
응답 처리
Server

성공 시 그룹 목록과 총 개수가 반환됩니다.

응답 필드
  • countinteger검색된 총 데이터 수
  • listarrayUserGroup 모델 배열
  • http_statusintegerHTTP 상태 코드
언어
1
2
curl -X GET "https://api.bootapi.com/v1/user-groups?corporate_type=2&page=1&limit=10" \  -H "Authorization: Bearer {ACCESS_TOKEN}"