crunchbase-degrees.yml

name: crunchbase-degrees
deployed: true
title: Crunchbase Degrees
description: Returns data about degrees
task:
  op: redirect
  path: https://api.flex.io/v1/integration-crunchbase/pipes/crunchbase-degrees/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 degree record
  - name: name
    type: string
    description: Name of the educational degree earned by a person (e.g. BS  Computer Science, M.A.  Physics, etc.)
  - name: type
    type: string
    description: Type of information described by the globally unique ID
  - name: permalink
    type: string
    description: Permalink for the degree record
  - name: cb_url
    type: string
    description: Crunchbase website page URL for the degree
  - 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: person_uuid
    type: string
    description: Globally unique ID for the person who earned the degree
  - name: person_name
    type: string
    description: Name of the person who earned the degree
  - name: institution_uuid
    type: string
    description: Globally unique ID for the organization which awarded the degree
  - name: institution_name
    type: string
    description: Name of the organization which awarded the degree
  - name: degree_type
    type: string
    description: Type of degree (BA, Ph.D, MBA, etc.)
  - name: subject
    type: string
    description: Subject field for the degree (e.g. Computer Science, Law, Economics, etc.)
  - name: started_on
    type: date
    description: Date the program for the degree was started
  - name: completed_on
    type: date
    description: Date the degree was awarded
  - name: is_completed
    type: boolean
    description: Indicates whether the program for the degree was completed
examples:
  - '"*"'
  - '"person_name, institution_name, degree_type, subject","""Elon Musk"""'
  - '"person_uuid, person_name, institution_name, degree_type, subject, completed_on","+Physics +completed_on:>=2015-01-01"'
  - '"person_uuid, person_name, institution_name, degree_type, subject, completed_on","(Stanford OR MIT) AND completed_on:>=2020-01-01"'
notes: |-
  Additional Resources:
  * Flexio Crunchbase Templates: \
    https://www.flex.io/integrations/crunchbase/
  * Flexio Function Syntax Tutorial: \
    https://www.flex.io/resources/examples/