Update API calls

📘

For existing API customers

This migration guide is for customers whose API access has already been provisioned. New API access is available through direct sales only. To obtain access and an API key, contact the Crunchbase sales team. The Show Key steps below retrieve an existing, provisioned key.

What’s Changed with Key Access?
Crunchbase has moved away from legacy API keys and introduced new packaging tiers based on access to Crunchbase’s proprietary company intelligence. If you’re a legacy customer, your new API key has been provisioned to a package that reflects your current contract and level of access.

What steps do I need to take?
This guide explains how to retrieve your new API key, complete the migration, and update the Crunchbase endpoints you call.

1. Retrieve your new API key

   1. Login to Crunchbase >Go to Account Settings > Integrations > Crunchbase API.
   2. You’ll see your updated API package (the package will be reflective of your legacy plan’s access) - click “Show Key” to access your new API key

2. Update your API Calls
   Once you have your new API key, replace your old API credentials in the API calls you make to Crunchbase endpoints.

   1. Direct in-call authentication: Send your new API key in the X-cb-user-key request header. This is the recommended authentication method.
   2. Stored authentication method: Update your saved key in platforms such as Postman or your internal integration, and configure requests to send it in the X-cb-user-key header.

   For example:

   Bash

   curl --request GET 'https://api.crunchbase.com/v4/data/entities/organizations/crunchbase' \
     --header 'X-cb-user-key: INSERT_YOUR_API_KEY_HERE' \
     --header 'Accept: application/json'

   The user_key URL query parameter remains supported as an alternative. Prefer the header because URLs can appear in browser history, logs, and monitoring systems. See Authentication for details.

3. Test and Confirm Your Migration

   1. Update and test that all the endpoints are working with your new key.
   2. Once validated, notify our team that the new key is in use so we can deprecate your legacy key.

Note the URL Path Update

Use the URL for the endpoint you are calling. The current API uses two path patterns:

The /data/ segment applies to data endpoints, including entity lookups, single-card lookups, searches, autocomplete, and deleted entities. Metadata endpoints use /md/ instead, including /v4/md/applications/crunchbase/fields and the OpenAPI JSON and YAML definitions. Do not insert /data/ into metadata URLs.

For legacy endpoint replacements, consult the legacy-to-current URL mapping and use the destination URL for each endpoint. See the API Reference for the current paths available to your package.

For additional details, refer to the migration guide on Crunchbase's Knowledge Center.