What is the endpoint for [B034] Organization basic information?

The [B034] Organization basic information endpoint is GET https://connect.patsnap.com/synapse/organization/basic-info.

What data can [B034] Organization basic information return?

[B034] Organization basic information Obtain organization basic information about stock symbol, founded date, tags etc. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for [B034] Organization basic information?

The OpenAPI schema is available at /openapi.json#/paths/~1synapse~1organization~1basic-info/get. You can also browse the full specification at /openapi.json.

[B034] Organization basic information

get

https://connect.patsnap.com/synapse/organization/basic-info

Try in Sandbox

Obtain organization basic information about stock symbol, founded date, tags etc.

TAG Source: The top three therapeutic area and the top three drug types related to the current pipelines of the organization.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`organization_id` Required	`string`	`11ef8a9e8bf5ca80213a1183511cded3`	Organization ID, obtain this through the organization autocomplete interface

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`tags`	`array`	`[ { "id": "62eaee6d9ee44410b8aca59dfc7408e9", "type": "THERAPEUTIC_AREA", "display_name": [ { "lang": "EN", "name": "Neoplasms" }, { "lang": "CN", "name": "肿瘤" } ] }, { "id": "c38eb408d6b842f487d6a27484156633", "type": "DRUG_TYPE", "display_name": [ { "lang": "EN", "name": "Monoclonal antibody" }, { "lang": "CN", "name": "单克隆抗体" } ] } ]`	Result Items
`id`	`string`	`62eaee6d9ee44410b8aca59dfc7408e9`	ID
`type`	`string`	`THERAPEUTIC_AREA`	Type, Therapeutic Area/Drug Type
`display_name`	`array`	`[ { "lang": "EN", "name": "Neoplasms" }, { "lang": "CN", "name": "肿瘤" } ]`	Name
`lang`	`string`	`EN`	Language
`name`	`string`	`Ranibizumab (Genentech)`	Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
`address`	`object`	`{ "address": { "city": "Thousand Oaks", "state": "California", "country": "United States" } }`	Address
`city`	`string`	`Thousand Oaks`	City
`state`	`string`	`California`	State
`country`	`string`	`United States`	Country
`founded_date`	`string`	`19800101`	Founded Date
`stock_symbol`	`string`	`AMGN`	Stock Symbol
`stock_exchange_code`	`string`	`NASDAQ`	Stock Exchange Code
`status` Required	`boolean`	`false`	Status
`error_msg`	`string`	`The request parameter format is incorrect！`	Error Message
`error_code` Required	`integer`	`0`	Error Code

Success Response Example

Example of a successful API response

JSON

{
  "data": {
    "tags": [
      {
        "id": "62eaee6d9ee44410b8aca59dfc7408e9",
        "type": "THERAPEUTIC_AREA",
        "display_name": [
          {
            "lang": "EN",
            "name": "Ranibizumab (Genentech)"
          }
        ]
      }
    ],
    "address": {
      "city": "Thousand Oaks",
      "state": "California",
      "country": "United States"
    },
    "founded_date": 19800101,
    "stock_symbol": "AMGN",
    "stock_exchange_code": "NASDAQ"
  },
  "status": true,
  "error_code": 0
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

Error Code	Description
`68300004`	Invalid parameter!
`68300005`	Search api failure!
`68300006`	Analytic basic access error!
`68300007`	Bad request!
`68300008`	Service error, please try again later!
`68300010`	The file does not comply with upload specifications!

Platform Errors

Error Code	Description
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	Quota exceeds the limit!
`67200003`	Access token expired or authentication error!
`67200004`	No permission or API package quota has exceeded the limit!
`67200005`	Insufficient balance, call failed!
`67200006`	This client has expired and call failed!
`67200007`	Exceeded the call limit, call failed!

HTTP Status Codes

Status Code	Description
`0`	Success
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found

Performance Metrics

Expected performance characteristics for this endpoint

Normal Response Time

5000 ms

Max Response Time

10000 ms