고객 목록 조회

고객의 정보들을 목록으로 조회합니다.

GET

• Example Request

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

• Example Response

{
  "success": true,
  "data": {
    "peopleList": [
      {
        "id": "644215c250e381db28bc4704",
        "name": "Example_People",
        "email": "[e-mail]",
        "phoneNumber": "01011112222",
        // (이하 기타 데이터 필드)
        "organization": {
          "id": "644215a350e381db28bc467f",
          "이름": "Example_Organization"
          // (이하 기타 데이터 필드)
          },
        "url": "https://salesmap.kr/00001234-0000-0000-0000-00000/contact/people/644215c250e381db28bc4704",
        "createdAt": "2023-04-21T05:01:45.939Z"
      },
      {
        // 다음 사람 항목...
      }
    ]
  }
}

Header

• Authorization

  • required string

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

Query Parameter

• page

  • required Integer

조회를 원하는 고객의 범위. page의 값에 따라 50개 단위로 목록을 조회합니다.

​Response

• success

  • boolean

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

• data

  • object

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

    • peopleList

      • list

      • 조건에 맞는 고객의 목록입니다.

        • id

          • string

          • 고객의 고유 id 입니다.

        • 이름

          • string

          • 고객의 이름입니다.

        • 이메일

          • string

          • 고객의 이메일입니다.

        • 전화

          • string

          • 고객의 전화번호 입니다.

        • (이하 세일즈맵 탭에서 [회사 설정] - [데이터 필드 관리]을 클릭했을때 확인 할 수 있는 고객의 데이터 필드를 리턴 받습니다. 생성한 데이터 필드의 이름과 값이 설정한대로 포함됩니다.)

        • organization

          • object

          • 고객의 회사의 정보입니다.

        • url

          • string

          • 해당 고객의 링크 입니다.

        • 생성 날짜

          • string

          • 고객의 생성된 날짜 입니다.