crunchbase-investments.yml

name: crunchbase-investments
deployed: true
title: Crunchbase Investments
description: Returns data about investments
task:
  op: redirect
  path: https://api.flex.io/v1/integration-crunchbase/pipes/crunchbase-investments/run
params:
  - name: properties
    type: array
    description: The properties to return, given as a string or array; defaults to all properties; see "Returns" for available properties
    required: false
  - name: filter
    type: array
    description: Search query to determine the rows to return, given as a string or array
    required: false
returns:
  - name: uuid
    type: string
    description: Globally unique ID for the investment
  - name: name
    type: string
    description: Name of the investment
  - name: type
    type: string
    description: Type of information described by the globally unique ID
  - name: permalink
    type: string
    description: Permalink for the investment
  - name: cb_url
    type: string
    description: Crunchbase website page URL for the investment
  - name: rank
    type: integer
    description: Algorithmic rank assigned to the record
  - name: created_at
    type: date
    description: Date the record was created in the system
  - name: updated_at
    type: date
    description: Date the information for the record was last updated in the system
  - name: funding_round_uuid
    type: string
    description: Globally unique ID for the funding round associated with the investment
  - name: funding_round_name
    type: string
    description: Name of funding round associated with the investment
  - name: investor_uuid
    type: string
    description: Globally unique ID for the investor (related to crunchbase-investors)
  - name: investor_name
    type: string
    description: Name of the investor (related to crunchbase-investors)
  - name: investor_type
    type: string
    description: Type of investor (e.g. organization, person, etc.)
  - name: is_lead_investor
    type: boolean
    description: Indicates whether the organization or person was the lead investor
examples:
  - '"*"'
  - '"investor_name, investor_type, is_lead_investor, funding_round_name, cb_url", "+investor_name:""Jeff Bezos"""'
  - '"investor_name, investor_type, is_lead_investor, funding_round_name, cb_url", "+funding_round_name: Google -funding_round_name:Adometry"'
  - '"investor_name, investor_type, is_lead_investor, funding_round_name, cb_url", "+is_lead_investor:True +funding_round_name:""Series A"""'
notes: |-
  Additional Resources:
  * Flexio Crunchbase Templates: \
    https://www.flex.io/integrations/crunchbase/
  * Flexio Function Syntax Tutorial: \
    https://www.flex.io/resources/examples/