ReferralOpportunity

  • createdAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • currency
    Type: string
    required
  • id
    Type: stringFormat: uuid
    required

    Referral pipeline deal id

  • name
    Type: string
    required
  • pipelineDealId
    Type: stringFormat: uuid
    required

    Same as id — public durable id for the referral hub deal

  • updatedAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • connector
    Type: object | null
    • company
      Type: object | null
    • email
      Type: string | null
    • firstName
      Type: string | null
    • id
      Type: stringFormat: uuid
    • lastName
      Type: string | null
  • description
    Type: string | null
  • expectedValue
    Type: number | null
  • facilitators
    Type: array object[] · ReferralOpportunityFacilitator[]
    • company
      Type: object | null
    • companyId
      Type: string | nullFormat: uuid
    • id
      Type: stringFormat: uuid
    • role
      Type: stringenum
      values
      • connector
      • facilitator
      • referral_source
    • side
      Type: string | nullenum
      values
      • seeker
      • provider
    • user
      Type: object | null
    • userId
      Type: string | nullFormat: uuid
  • owner
    Type: object
    • email
      Type: string
    • firstName
      Type: string
    • id
      Type: stringFormat: uuid
    • lastName
      Type: string
  • provider
    Type: object

    Resolved seeker or provider (USER or COMPANY)

    • company
      Type: object | null
    • email
      Type: string | null
    • firstName
      Type: string | null
    • id
      Type: stringFormat: uuid
    • lastName
      Type: string | null
    • name
      Type: string | null

      Present for COMPANY-shaped entities

    • type
      Type: stringenum
      values
      • USER
      • COMPANY
  • seeker
    Type: object

    Resolved seeker or provider (USER or COMPANY)

    • company
      Type: object | null
    • email
      Type: string | null
    • firstName
      Type: string | null
    • id
      Type: stringFormat: uuid
    • lastName
      Type: string | null
    • name
      Type: string | null

      Present for COMPANY-shaped entities

    • type
      Type: stringenum
      values
      • USER
      • COMPANY
  • stage
    Type: object
    • color
      Type: string
    • description
      Type: string
    • id
      Type: stringFormat: uuid
    • label
      Type: string
    • sortOrder
      Type: integer

      Integer numbers.

Introzy API Documentation