유저 조회

유저를 조회합니다.

GET

• Example Request

curl --location -G 'https://salesmap.kr/api/v1/user?page=0' \
--header 'Authorization: Bearer <token>'

• Example Response

{
  "success": true,
    "data": {
      "userList": [
        {
          "id": "<UserId>",
          "name": "유저 이름",
          "status": "활성화",
          "emailAddress": "[e-mail]",
          "role": "어드민"
        },
        {
          // 다음 유저 항목...
        },
        {...},
        {...},
    ]
  }
}

Header

• Authorization

  • required string

Bearer 토큰을 포함한 인증 헤더입니다.

쿼리 파라미터

• page

  • required Integer

조회를 원하는 액티비티의 범위

​Response

• success

  • boolean

  • 요청을 성공적으로 완료한 경우 true, 실패한 경우 false 입니다.

• data

  • object

  • 결과 값인 userList를 포함한 오브젝트 입니다.

    • userList

      • list

      • 조건에 맞는 유저 목록입니다.

        • id

          • string

          • 유저 고유 id 입니다.

        • name

          • string

          • 유저의 이름입니다.

        • status

          • string

          • 유저의 상태입니다.

          • 활성화, 비활성화 중 하나의 값을 가집니다.

        • emailAddress

          • string

          • 유저의 이메일 주소입니다.

        • role

          • string

          • 유저의 역할입니다.