Access Crunchbase Data

Integrate Crunchbase data into your business, perform analysis, and build applications

Using Entity Lookup API

Instructions on how to use Crunchbase's Entity Lookup API endpoints

The Entity Lookup API endpoints are provided so you can retrieve data - data fields and relationships - from a specific entity. We provide Entity Lookup endpoints for many of our collections - e.g. organizations, people, funding rounds, and acquisitions. If any ranges or limitations exist, they will be noted within our reference documentation. For details on all of our collections, please visit our API Reference page

To make a request using our Entity Lookup APIs, you must provide the following:

  • a user key
  • an {entity_id} - which can either be the UUID or the permalink (e.g. "crunchbase") of the entity

You can also ask for additional data fields and relationships in the response by adding the "field_ids" and/or "card_ids" parameters to the request. Here is an example below:

GET https://api.crunchbase.com/api/v4/entities/organizations/tesla-motors?card_ids=founders,raised_funding_rounds&field_ids=categories,short_description,rank_org_company,founded_on,website,facebook,created_at&user_key=INSERT_KEY_HERE
curl --request GET 'https://api.crunchbase.com/api/v4/entities/organizations/tesla-motors?card_ids=founders,raised_funding_rounds&field_ids=categories,short_description,rank_org_company,founded_on,website,facebook,created_at&user_key=INSERT_KEY_HERE'

how do I know what data are available to be returned in the response?

You can quickly see what data fields & relationships are available to be returned in the response for each collection by going to the specific endpoint's response schema.

  • The field names listed under "Properties" are what you will put as the value for "field_ids"
  • The card names listed under "Cards" are what you will put as the value for "card_ids"

Steps by Steps:

    1. First go to the endpoint that you are interested in (let's say Entity Lookup for Organization)
    1. Scroll down to the Responses section
    1. Click on Schema (screenshot below)

🚧

Expect all data fields & relationships to be optional

Unless otherwise called out as a required field or relationship in the response schema, please configure your system/process to treat data fields & relationships (e.g. "card_ids") in the response as optional.

🚧

"Card" returns 100 items max

If you choose to add a "card_id" to your request, please note that "card" will only return a max of 100 items.

To retrieve more results from a "card", you can paginate for more results by using the lookup API endpoint for a single card. More details in the section below

how do I get more results from a single "card_id"?

To retrieve more results from a "card", you can paginate for more results by using the lookup API endpoint for a single card. (ex: /entities/organizations/{entity_id}/cards/{card_id})

To make a request using our API to look up a single card_id for an entity, you must provide the following:

  • a user key
  • an {entity_id} - which can either be the UUID or the permalink (e.g. "crunchbase") of the entity
  • a {card_id} - this is the specific card that you are interested in

You can further customize the API request by adding optional parameters:

  • array of {card_field_ids} - use this option to ask for specific data field(s) to be returned in your response instead of the default fields (ex: "announced_on, funding_round_identifier, is_lead_investor")
  • {after_id} - this is used to paginate to the next page; provide the uuid of the last item in the current page to get the results for the next page
  • {before_id} - this is used to paginate to the previous page; provide the uuid of the first item in the current page to get the results for the previous page
  • {order} - similar to the Search API endpoint, you can sort the list of items returned by a specific field and direction (asc/desc) (ex: "announced_on desc")
  • {limit} - similar to the Search API endpoint, you can ask for a specific number of items to be returned (max is 100)

Here is an example below:

*note*
- entity permalink: mayfield-fund
- card_id: participated_investments
- after_id: 67e13ea9-100d-4cea-2d51-22c0149e7e93
- order: announced_on (descending)

*request*
GET https://api.crunchbase.com/api/v4/entities/organizations/mayfield-fund/cards/participated_investments?after_id=67e13ea9-100d-4cea-2d51-22c0149e7e93&order=announced_on%20desc&user_key=[user_key]
*note*
- entity permalink: mayfield-fund
- card_id: participated_investments
- after_id: 67e13ea9-100d-4cea-2d51-22c0149e7e93
- order: announced_on (descending)

*request*
curl --request GET 
'https://api.crunchbase.com/api/v4/entities/organizations/mayfield-fund/cards/participated_investments?after_id=67e13ea9-100d-4cea-2d51-22c0149e7e93&order=announced_on%20desc&user_key=[user_key]'

📘

Pro Tips: find permalink easily

Want to find the permalink for an entity?

Updated about a month ago


Using Entity Lookup API


Instructions on how to use Crunchbase's Entity Lookup API endpoints

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.