딜 목록 조회

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

GET

• Example Request

curl --location -G 'https://salesmap.kr/api/v1/deal?page=0' \
--data-urlencode 'pipelineName=기본 파이프라인' \
--data-urlencode 'pipelineStageName=상담 시작 전' \
--header 'Authorization: Bearer <Token>'

• Example Response

{
  "success": true,
  "data": {
    "dealList": [
    {
      "id": "644218b950e381db28bc486f",
      "이름": "Example_deal1",
      "금액": 50000,
      // (이하 기타 데이터 필드들)
      "people": {
        "id": "644215c250e381db28bc4704",
        "이름": "Exmaple_People",
        "이메일": "[e-mail]",
        "전화": "01011112222"
        // (이하 기타 데이터 필드들)
        },
      "organization": {
        "id": "644215a350e381db28bc467f",
        "이름": "Example_Organization"
        // (이하 기타 데이터 필드들)
        },
      "생성 날짜": "2023-04-21T05:01:45.939Z"
    },
    {...},
    {...}, 
    ]
  }
}

Header

• Authorization

  • required string

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

Query Parameter

• page

  • required Integer

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

• pipelineName

  • String

조회를 원하는 딜의 파이프라인 이름

• pipelineStageName

  • String

조회를 원하는 딜의 파이프라인 스테이지 이름

​Response

• success

  • boolean

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

• data

  • object

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

    • dealList

      • list

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

        • id

          • string

            • 딜의 고유 id 입니다.

          • 이름

            • string

            • 딜의 이름입니다.

          • 금액

            • string

            • 딜의 금액입니다.

          • 소스

            • string

            • 딜의 소스입니다.

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

          • people

            • object

            • 딜의 고객 정보입니다.

          • organization

            • obejct

            • 딜의 회사 정보입니다.

          • 생성 날짜

            • string

            • 생성된 날짜입니다.