고객 목록 조회

등록된 고객 목록을 조건에 따라 조회하는 API입니다.
개인 회원, 기업 회원, 비회원 등 다양한 유형의 고객을 통합적으로 조회할 수 있습니다.

GET
https://api.bootapi.com/v1/users
검색 옵션
type: user
user_id, 이름, 휴대폰, 이메일 검색
type: user_group
user_group_id로 검색
1
SDK 설치
Server

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

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

조건에 맞는 고객 목록을 조회합니다.

요청 파라미터
  • memberTypeinteger회원 유형 (1: 회원, 2: 비회원)
  • typestring검색 타입 (user 또는 user_group)
  • keywordstring검색 키워드 (이름, 전화번호, 이메일, 외부 고유 ID(ex_uid) 검색 가능)
  • pageinteger페이지 번호
  • limitinteger페이지당 데이터 수
3
응답 처리
Server

응답에서 countlist를 확인합니다.

응답 필드
  • countnumber조회된 총 데이터 수
  • listArray고객 목록 배열
  • list[].user_idstring고객 고유 ID
  • list[].login_idstring로그인 아이디
  • list[].namestring고객 이름
  • list[].membership_typenumber회원 유형 (1: 회원)
  • list[].statusnumber계정 상태 (1: 활성)
활용 예시
list를 순회하여 고객 목록 표시
count로 페이지네이션 구현
user_id로 상세 조회 연동

에러 코드

API_PARAM_INVALID
파라미터가 올바르지 않습니다.
요청 파라미터 형식을 확인하세요.
ACCESS_TOKEN_INVALID
유효하지 않은 Access Token입니다.
Access Token을 다시 발급받으세요.
언어

Document not found, overwrite this content with #not-found slot in <ContentDoc>.