---
canonical_url: "https://docs.composio.dev/toolkits/crunchbase"
markdown_url: "https://docs.composio.dev/toolkits/crunchbase.md"
product: "platform"
version: null
last_updated: null
---

# Crunchbase

Crunchbase provides company, people, funding, financial, prediction, and market insight data through its package-entitled Enterprise API.

- **Category:** business intelligence
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 7
- **Triggers:** 0
- **Slug:** `CRUNCHBASE`
- **Version:** 00000000_00

## Tools

### Autocomplete Entities

**Slug:** `CRUNCHBASE_AUTOCOMPLETE_ENTITIES`

Suggest Crunchbase entity identifiers and permalinks matching text, optionally limited to documented or key-entitled collections.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum suggestions to return (up to 25). |
| `query` | string | Yes | Text to autocomplete into Crunchbase entity identifiers or permalinks. |
| `collection_ids` | array | No | Optional collection names to search. Accepts the connected key's licensed collections; use Get Fields Metadata to discover them. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Entity

**Slug:** `CRUNCHBASE_GET_ENTITY`

Get one Crunchbase entity by collection and UUID or permalink, selecting licensed fields and optionally embedded relationship cards. Access depends on the package entitlements of the connected API key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `card_ids` | array | No | Licensed relationship cards to embed. Embedded cards return at most 100 items; use LIST_ENTITY_CARD to continue a card. |
| `entity_id` | string | Yes | Entity UUID or permalink. |
| `field_ids` | array | No | Licensed entity fields to return. Use GET_FIELDS_METADATA to discover valid field IDs; unknown or unlicensed fields remain provider errors. |
| `collection` | string | Yes | Crunchbase collection name. Use GET_FIELDS_METADATA to discover the collections licensed to the connected key; the value is intentionally not restricted to a fixed enum. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fields Metadata

**Slug:** `CRUNCHBASE_GET_FIELDS_METADATA`

Return the connected Crunchbase key's licensed collections and field definitions, optionally filtered by collection. Filter by collection when the full licensed metadata exceeds the safe serialized response limit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_ids` | array | No | Collections whose licensed field metadata to return. Omit for all fields available to the connected Crunchbase key. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get OpenAPI Specification

**Slug:** `CRUNCHBASE_GET_OPENAPI_SPECIFICATION`

Return the Crunchbase REST v4 OpenAPI surface licensed to the connected key in JSON or YAML. By default, return a compact operation and schema index; request full mode only when the complete document is needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mode` | string ("index" | "full") | No | Response detail. index returns a compact operation and schema inventory; full returns the complete package-specific OpenAPI document. |
| `format` | string ("json" | "yaml") | No | Specification format. Use json for structured inspection or yaml for a YAML document. |
| `path_prefix` | string | No | Optional path prefix for index mode, such as /data/searches or /data/entities/organizations. Omit to index every licensed path. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deleted Entities

**Slug:** `CRUNCHBASE_LIST_DELETED_ENTITIES`

List Crunchbase deletion records across supported collections or for one collection, with forward or backward keyset pagination. If a nonempty page omits the boundary UUID, pagination_warning reports that continuation is unavailable instead of claiming the page is terminal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum deletion records to return in this page (up to 25). |
| `cursor` | string | No | Opaque continuation cursor returned by this action. Omit for the first page and pass it back unchanged for the next page. |
| `direction` | string ("forward" | "backward") | No | Traverse forward using Crunchbase after_id semantics or backward using before_id semantics. |
| `collection_id` | string | No | One collection to place in the request path. Omit to list deletion records across supported collections. |
| `collection_ids` | array | No | Collections to filter on the all-collections route. Cannot be used with collection_id. |
| `deleted_at_order` | string ("asc" | "desc") | No | Sort deletion records by deletion time in ascending or descending order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Entity Card

**Slug:** `CRUNCHBASE_LIST_ENTITY_CARD`

List one Crunchbase entity relationship card with selected licensed fields and one-page forward or backward keyset pagination. Access depends on the package entitlements of the connected API key. If a nonempty page omits the boundary UUID or returns a different card key, pagination_warning reports that continuation is unavailable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum card items to return in this page (1-100). |
| `order` | string | No | Provider order expression for this card, such as a supported field name and asc or desc direction. Valid expressions are card-specific. |
| `cursor` | string | No | Opaque continuation cursor returned by this tool. It restores the collection, entity, card, selected fields, order, limit, and direction. |
| `card_id` | string | Yes | Licensed relationship card to retrieve. Card availability depends on the connected key's package entitlements. |
| `direction` | string ("forward" | "backward") | No | Traverse forward using Crunchbase after_id semantics or backward using before_id semantics. |
| `entity_id` | string | Yes | Parent entity UUID or permalink. |
| `collection` | string | Yes | Entity collection containing the card. Use GET_FIELDS_METADATA and Crunchbase references to discover routes licensed for the connected key. |
| `card_field_ids` | array | No | Licensed fields to return for each card item. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Entities

**Slug:** `CRUNCHBASE_SEARCH_ENTITIES`

Search one Crunchbase collection using licensed fields, up to 25 AND-combined predicates, ordering, and one-page keyset pagination. Pages can change while traversing; deduplicate entities by UUID when completeness matters. If a nonempty page omits the boundary UUID, pagination_warning reports that continuation is unavailable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum entities to return in this page (1-1000). |
| `order` | array | No | Optional ordered list of sort clauses. |
| `query` | array | Yes | Up to 25 predicates. Crunchbase combines separate predicates with AND; use a supported includes operator for alternatives within one predicate. The complete continuation context, including these predicates and selected fields, must serialize to at most 20,000 UTF-8 bytes. |
| `cursor` | string | No | Opaque continuation cursor returned by this tool. It restores the original collection, fields, predicates, order, limit, and direction. |
| `direction` | string ("forward" | "backward") | No | Traverse forward using after_id or backward using before_id semantics. |
| `field_ids` | array | Yes | Licensed fields to return for each entity. Use GET_FIELDS_METADATA to discover valid field IDs. |
| `collection` | string | Yes | Collection to search. Use GET_FIELDS_METADATA to discover the collections licensed for the connected key. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |