---
title: "B039 Drug deal information"
method: GET
path: "/synapse/drug-deal"
tags: ["Drug R&D Orgnization"]
---

# B039 Drug deal information

`GET /synapse/drug-deal`

## Request

- Base URL: `https://connect.patsnap.com`
- URL: `https://connect.patsnap.com/synapse/drug-deal`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/patsnap/apis/patsnap-open-platform-api/docs/synapse/drug-deal/get.ts> (a function with typed inputs; its response is checked against the schema)

Obtain drug deal information about partner, principle, deal time, drug etc.

## Query parameters

- `deal_id` string, required: Drug Deal ID, obtain this through the [B045] drug deal search interface

## Response `200`

Successful b039 drug deal information response.

- B039SynapseDrugDealResponse
  - `data` B039SynapseDrugDealGetDrugDealResponseDto
    - `drug` B039SynapseDrugDealCommonDrug[]: Drug, Referencing "CommonDrug"
      - `drug_id` string: Drug ID
      - `display_name` B039SynapseDrugDealCommonName[]: Drug Name, Referencing "CommonName"
        - `lang` string: Language
        - `name` string: Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
    - `target` B039SynapseDrugDealCommonTarget[]: Target, Referencing "CommonTarget"
      - `target_id` string: Target ID
      - `short_name` B039SynapseDrugDealCommonName[]: Target Short Name, Referencing "CommonName"
        - `lang` string: Language
        - `name` string: Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
      - `display_name` B039SynapseDrugDealCommonName[]: Target Full Name, Referencing "CommonName"
        - `lang` string: Language
        - `name` string: Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
    - `deal_id` string: Drug Deal ID
    - `partner` B039SynapseDrugDealCommonOrganization[]: Partner Organization, Referencing "CommonOrganization"
      - `display_name` B039SynapseDrugDealCommonName[]: Organization Name, Referencing "CommonName"
        - `lang` string: Language
        - `name` string: Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
      - `organization_id` string: Organization ID
    - `deal_time` integer: Drug Deal Time
    - `deal_type` B039SynapseDrugDealCommonDictionary[]: Deal Type, Referencing "CommonDictionary"
      - `display_name` B039SynapseDrugDealCommonName[]: Dict Name
        - `lang` string: Language
        - `name` string: Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
      - `normalized_id` string: Dict ID
    - `drug_type` B039SynapseDrugDealCommonDictionary[]: Drug Type, Referencing "CommonDictionary"
      - `display_name` B039SynapseDrugDealCommonName[]: Dict Name
        - `lang` string: Language
        - `name` string: Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
      - `normalized_id` string: Dict ID
    - `principle` B039SynapseDrugDealCommonOrganization[]: Principal Organization, Referencing "CommonOrganization"
      - `display_name` B039SynapseDrugDealCommonName[]: Organization Name, Referencing "CommonName"
        - `lang` string: Language
        - `name` string: Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
      - `organization_id` string: Organization ID
    - `deal_title` string: Drug Deal Title
    - `source_url` string: News link
    - `deal_status` B039SynapseDrugDealCommonDictionary
      - `display_name` B039SynapseDrugDealCommonName[]: Dict Name
        - `lang` string: Language
        - `name` string: Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
      - `normalized_id` string: Dict ID
    - `deal_total_value` B039SynapseDrugDealMoneyItem
      - `unit` string: Drug Deal Value Unit, Enum: million dollar. If the value is Undisclosed, return null.
      - `value` string: Drug Deal Value, if not disclosed, then return "Undisclosed"
    - `territory_excluded` B039SynapseDrugDealCommonCountry[]: Country/Location(Exclude), Referencing "CommonCountry"
      - `country_id` string: Country/Location ID
      - `alpha2_code` string: Alpha Code
      - `display_name` B039SynapseDrugDealCommonName[]: Country/Location Name
        - `lang` string: Language
        - `name` string: Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
    - `territory_included` B039SynapseDrugDealCommonCountry[]: Country/Location(Include), Referencing "CommonCountry"
      - `country_id` string: Country/Location ID
      - `alpha2_code` string: Alpha Code
      - `display_name` B039SynapseDrugDealCommonName[]: Country/Location Name
        - `lang` string: Language
        - `name` string: Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
    - `deal_upfront_payment` B039SynapseDrugDealMoneyItem
      - `unit` string: Drug Deal Value Unit, Enum: million dollar. If the value is Undisclosed, return null.
      - `value` string: Drug Deal Value, if not disclosed, then return "Undisclosed"
    - `deal_milestone_payment` B039SynapseDrugDealMoneyItem
      - `unit` string: Drug Deal Value Unit, Enum: million dollar. If the value is Undisclosed, return null.
      - `value` string: Drug Deal Value, if not disclosed, then return "Undisclosed"
  - `status` boolean, required: Status
  - `error_msg` string: Error Message
  - `error_code` integer, required: Error Code

## Other responses

- `401`: Unauthorized.
- `403`: Forbidden.
- `404`: Not Found.

---

[API](https://skmtc.dev/patsnap/apis/patsnap-open-platform-api.md) - [All operations](https://skmtc.dev/patsnap/apis/patsnap-open-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/patsnap/apis/patsnap-open-platform-api/revisions/c2264a0de595?raw)