crunchbase-category-groups.yml

name: crunchbase-category-groups
deployed: true
title: Crunchbase Category Groups
description: Returns data about category groups
task:
  op: redirect
  path: https://api.flex.io/v1/integration-crunchbase/pipes/crunchbase-category-groups/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 category group
  - name: name
    type: string
    description: Name of the category group (e.g. Software, Mobile, Clean Energy, etc.)
  - name: type
    type: string
    description: Type of information described by the globally unique ID
  - name: permalink
    type: string
    description: Permalink for the category group
  - name: cb_url
    type: string
    description: Crunchbase website page URL for the category group
  - 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: category_groups_list
    type: string
    description: List of related industry categories (e.g. Financial Services, Media and Entertainment, etc.)
examples:
  - '"*"'
  - '"name, permalink, category_groups_list", "+category_groups_list:Investments"'
  - '"name, permalink, category_groups_list", "+category_groups_list:Investments -Credit"'
  - '"name, permalink, category_groups_list", "venture OR angel"'
notes: |-
  Additional Resources:
  * Flexio Crunchbase Templates: \
    https://www.flex.io/integrations/crunchbase/
  * Flexio Function Syntax Tutorial: \
    https://www.flex.io/resources/examples/