crunchbase-events.yml

name: crunchbase-events
deployed: true
title: Crunchbase Events
description: Returns data about events
task:
  op: redirect
  path: https://api.flex.io/v1/integration-crunchbase/pipes/crunchbase-events/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 event
  - name: name
    type: string
    description: Name of the event
  - name: type
    type: string
    description: Type of information described by the globally unique ID
  - name: permalink
    type: string
    description: Permalink for the event
  - name: cb_url
    type: string
    description: Crunchbase website page URL for the event
  - 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: short_description
    type: string
    description: Short description of the event
  - name: started_on
    type: date
    description: Date the event started
  - name: ended_on
    type: date
    description: Date the event ended
  - name: event_url
    type: string
    description: Website URL for the event
  - name: registration_url
    type: string
    description: Website URL for the event registration page
  - name: venue_name
    type: string
    description: Name of the venue where the event occurred
  - name: description
    type: string
    description: Full description of the event
  - name: country_code
    type: string
    description: Country where the event occurred
  - name: state_code
    type: string
    description: State or province where the event occurred
  - name: region
    type: string
    description: Region where the event occurred
  - name: city
    type: string
    description: City where the event occurred
  - name: logo_url
    type: string
    description: Website URL for the event logo
  - name: event_roles
    type: string
    description: List of roles for the event (e.g. networking, demo day, class, expo, etc.)
examples:
  - '"*"'
  - '"name, permalink, started_on, ended_on, city, country_code", "name: Economic"'
  - '"name, permalink, started_on, ended_on, city, country_code", "+state_code:CA +started_on:>=2020-01-01"'
  - '"name, permalink, started_on, ended_on, venue_name, state_code", "+venue_name:Moscone"'
notes: |-
  Additional Resources:
  * Flexio Crunchbase Templates: \
    https://www.flex.io/integrations/crunchbase/
  * Flexio Function Syntax Tutorial: \
    https://www.flex.io/resources/examples/