Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a Crunchbase Free source in Nexla.
cb_free_api.png

Crunchbase Free

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Crunchbase Free connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Crunchbase Free instance, and click Next; or, create a new Crunchbase Free credential for use in this flow.

  3. In Nexla, Crunchbase Free data sources can be created using pre-built endpoint templates, which expedite source setup for common Crunchbase Free endpoints. Each template is designed specifically for the corresponding Crunchbase Free endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Crunchbase Free sources can also be configured manually, allowing you to ingest data from Crunchbase Free endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Crunchbase Free endpoints. Each template is designed specifically for the corresponding Crunchbase Free endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Fetch Organization by Domain Name

    This endpoint fetches organizations by submitting a domain name, which will then return information about corresponding organizations. Use this endpoint when you need to retrieve organization data based on domain names.

    • Enter the domain name of the organization you wish to fetch data for in the Organization Domain Name field. For example: nexla.com or www.nexla.com. The default value is nexla.com if not specified.

    • The endpoint uses GET requests to https://api.crunchbase.com/v3.1/odm-organizations?user_key={api_key}&domain_name={domain_name} where {api_key} is your API user key from the credential configuration and {domain_name} is the domain name you provide. The endpoint URL is automatically constructed based on your credential's API key and the domain name parameter.
    • The endpoint uses incrementing page-based pagination, automatically fetching additional pages as needed using the page and items_per_page query parameters. The endpoint starts from page 1 and continues fetching pages until all available organizations have been retrieved. By default, the endpoint retrieves up to 100 items per page.
    • The endpoint will return all organizations matching the domain name. The response data is extracted from the data.items array in the API response ($.data.items[*]), with each organization record processed individually.

    Domain names should be entered without the protocol (https://) prefix. For example, use nexla.com instead of https://nexla.com. This endpoint supports pagination through page and items_per_page query parameters. Nexla automatically handles pagination to retrieve all available records by incrementing the page number until no more data is returned. The endpoint uses incrementing page-based pagination (iteration.type: paging.incrementing), starting from page 1. By default, the endpoint retrieves up to 100 items per page (page.expected.rows: 100). The response data path is $.data.items[*], which extracts all items from the data.items array in the API response. For detailed information about fetching organizations by domain name, see the Crunchbase API documentation.

    Fetch Organization by Domain Name from Lookup

    This endpoint fetches organizations by submitting domain names from a Nexla Lookup, which will then return information about corresponding organizations. Use this endpoint when you need to retrieve organization data for multiple domain names stored in a Nexla Lookup.

    • Select the Nexla Lookup that contains domain names to iterate over from the Lookup for fetching Domain Names dropdown menu. The lookup should contain domain names in one of its columns.

    • Enter the column name that contains the domain names in the Domain Name column name in Lookup field. This should match the exact column name in your selected lookup that contains the domain name values.

    • The endpoint uses GET requests to https://api.crunchbase.com/v3.1/odm-organizations?user_key={api_key}&domain_name={domain_name} where {api_key} is your API user key from the credential configuration and {domain_name} is iterated from the selected lookup column. The endpoint URL is automatically constructed for each domain name in the lookup.
    • The endpoint uses incrementing page-based pagination, automatically fetching additional pages as needed using the page and items_per_page query parameters. The endpoint starts from page 1 and continues fetching pages until all available organizations have been retrieved. By default, the endpoint retrieves up to 100 items per page.
    • The endpoint will return all organizations matching the domain names from the lookup. The response data is extracted from the data.items array in the API response ($.data.items[*]), with each organization record processed individually.

    This endpoint iterates through all domain names in the selected lookup column, making a separate API call for each domain name. The lookup must contain domain names in the specified column. Domain names should be stored without the protocol (https://) prefix. This endpoint supports pagination through page and items_per_page query parameters. Nexla automatically handles pagination to retrieve all available records by incrementing the page number until no more data is returned. The endpoint uses incrementing page-based pagination (iteration.type: paging.incrementing), starting from page 1. By default, the endpoint retrieves up to 100 items per page (page.expected.rows: 100). The response data path is $.data.items[*], which extracts all items from the data.items array in the API response. For detailed information about fetching organizations by domain name, see the Crunchbase API documentation.

    Fetch Recently Updated Organizations in Location

    This endpoint fetches recently updated organizations located in a specified region. Use this endpoint when you need to retrieve organizations that have been updated within a certain time period in a specific location.

    • Enter the location string to filter organizations in the Location field. The location string can be comma-separated for multiple locations. For example: California or California, New York. The default value is California if not specified.

    • Enter the date to restrict results to organizations updated since this time in the Updated Since (Nexla Macro or Absolute Date) field. You can use Nexla macro format for relative dates (e.g., {now}, {now-1}) or an absolute date. The default value is {now-1} if not specified.

    • The endpoint uses GET requests to https://api.crunchbase.com/v3.1/odm-organizations?user_key={api_key}&locations={location}&updated_since={updated_since} where {api_key} is your API user key, {location} is the location string, and {updated_since} is the updated since date. The endpoint URL is automatically constructed based on your credential's API key and the provided parameters.
    • The endpoint uses incrementing page-based pagination, automatically fetching additional pages as needed using the page and items_per_page query parameters. The endpoint starts from page 1 and continues fetching pages until all available organizations have been retrieved. By default, the endpoint retrieves up to 100 items per page.
    • The endpoint will return all recently updated organizations in the specified location. The response data is extracted from the data.items array in the API response ($.data.items[*]), with each organization record processed individually.

    Location strings can be comma-separated for multiple locations. The updated_since parameter accepts Nexla macros like {now} for the current time or {now-1} for one day ago, or you can use absolute dates. This endpoint supports pagination through page and items_per_page query parameters. Nexla automatically handles pagination to retrieve all available records by incrementing the page number until no more data is returned. The endpoint uses incrementing page-based pagination (iteration.type: paging.incrementing), starting from page 1. By default, the endpoint retrieves up to 100 items per page (page.expected.rows: 100). The response data path is $.data.items[*], which extracts all items from the data.items array in the API response. For detailed information about fetching organizations by location, see the Crunchbase API documentation.

    Fetch People by Query String

    This endpoint fetches people by submitting a query string, which will result in a full-text query of name, title, and company. Use this endpoint when you need to search for people based on their name, job title, or company affiliation.

    • Enter the query string for the full-text search in the Query String field. This query will search across name, title, and company fields. For example: Crunchbase or CEO. The default value is Crunchbase if not specified.

    • The endpoint uses GET requests to https://api.crunchbase.com/v3.1/odm-organizations?user_key={api_key}&query={query} where {api_key} is your API user key from the credential configuration and {query} is the query string you provide. Note: The endpoint URL uses odm-organizations but the query parameter filters for people data.
    • The endpoint uses incrementing page-based pagination, automatically fetching additional pages as needed using the page and items_per_page query parameters. The endpoint starts from page 1 and continues fetching pages until all available people have been retrieved. By default, the endpoint retrieves up to 100 items per page.
    • The endpoint will return all people matching the query string. The response data is extracted from the data.items array in the API response ($.data.items[*]), with each person record processed individually.

    The query string performs a full-text search across name, title, and company fields. This endpoint supports pagination through page and items_per_page query parameters. Nexla automatically handles pagination to retrieve all available records by incrementing the page number until no more data is returned. The endpoint uses incrementing page-based pagination (iteration.type: paging.incrementing), starting from page 1. By default, the endpoint retrieves up to 100 items per page (page.expected.rows: 100). The response data path is $.data.items[*], which extracts all items from the data.items array in the API response. For detailed information about fetching people by query, see the Crunchbase API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Crunchbase Free data sources can be manually configured to ingest data from any valid Crunchbase ODM API v3.1 endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Crunchbase Free sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Crunchbase Free API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API
    • POST: For sending data to the API or triggering actions
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the Crunchbase Free API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Crunchbase Free API endpoints typically follow the pattern https://api.crunchbase.com/v3.1/{'{endpoint_path}'}. Remember to include the user_key query parameter with your API user key.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires API user key authentication via the user_key query parameter, which is handled automatically by your credential configuration. For detailed information about Crunchbase Free API endpoints and available APIs, see the Crunchbase API documentation.

Path to Data​

  1. Enter the JSON path that identifies the location of the relevant data within the API response in the Path to Data field. JSON paths use dot notation to navigate through nested JSON structures.

    • For example, if your API response has the structure {"data": {"items": [...]}}, you would enter $.data.items[*] to extract all items from the items array.
    • Use $[*] to extract all items from a root-level array.
    • Use $ to extract the entire root-level object.

JSON paths are case-sensitive and must match the exact structure of your API response. Crunchbase Free API responses typically use a data.items array structure to contain the actual data. Use the Test button to verify that your JSON path correctly extracts the desired data from the API response.

Save the Data Source​

  1. Once all configuration steps have been completed, click the Save button to save your data source configuration.

  2. The data source will now be available in your data flow and will begin ingesting data according to the configured schedule and endpoint settings.