리드 목록 조회

리드의 정보들을 목록으로 조회 합니다.

GET

• Example Request

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

• Example Response

{
  "success": true,
  "data": {
    "leadList": [
      {
        "id": "00000-aaaa-bbbb-cccc-ddd",
        "url": "https://salesmap.kr/00001234-0000-0000-0000-00000/lead/inbox/00000-aaaa-bbbb-cccc-ddd",
        "이름": "sample_lead",
        "금액": "324,000"
        // (이하 기타 데이터 필드들)
        "people" : {
          "_id": "11112222-0000-aaaaa-bbbb",
          "이름": "sample_peopleName",
          "이메일": "[e-mail]"
          // (이하 기타 데이터 필드들)
        },
        "organization" : {
          "_id": "999999-00000-8888-3333",
          "이름": "sample_organizationName",
          "이메일": "[e-mail]",
          // (이하 기타 데이터 필드들)
        },
      },
      {...},
      {...}, 
    ]
  }
}

Header

• Authorization

  • required string

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

Query Parameter

• page

  • Integer

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

​Response

• success

  • boolean

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

• data

  • object

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

    • leadList

      • list

      • 조건에 맞는 리드의 목록입니다.

        • id

          • string

            • 리드의 고유 id 입니다.

        • 이름

          • string

          • 리드의 이름입니다.

        • 금액

          • string

          • 리드의 금액입니다.

        • 소스

          • string

          • 리드의 소스입니다.

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

        • people

          • string

          • 리드의 고객 정보입니다.

        • organization

          • string

          • 리드의 회사 정보입니다.

        • 생성 날짜

          • string

          • 생성된 날짜입니다.