Headers

• X-PLANNR-ACCOUNT-UUID string

Path parameters

• referralConnection_uuid string Required

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • uuid string

    The UUID of the resource.

  • direction string

    The direction of the connection relative to the current firm. Possible values: sent, received

  • status string

    The status of the referral connection. Possible values: pending, accepted, denied, expired

  • sender_firm object

    The firm that sent the referral connection request

    Hide sender_firm attributes Show sender_firm attributes object

    • uuid string
    • name string
  • recipient_firm object

    The firm that received the referral connection request

    Hide recipient_firm attributes Show recipient_firm attributes object

    • uuid string
    • name string
  • sender_account object

    The account that sent the referral connection request

    Hide sender_account attributes Show sender_account attributes object

    • uuid string
    • created_at string
    • updated_at string
    • type string
    • role string
    • first_name string
    • last_name string
    • name string
    • email string
    • photo_url string
    • external_references object
      Hide external_references attributes Show external_references attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • third_party

        The third party provider with the reference.

      • reference

        The third party reference.

  • recipient_account object

    The account that received the referral connection request

    Hide recipient_account attributes Show recipient_account attributes object

    • uuid string
    • created_at string
    • updated_at string
    • type string
    • role string
    • first_name string
    • last_name string
    • name string
    • email string
    • photo_url string
    • external_references object
      Hide external_references attributes Show external_references attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • third_party

        The third party provider with the reference.

      • reference

        The third party reference.

  • created_at string

    The timestamp of when the resource was created.

  • updated_at string

    The timestamp of when the resource was updated.

  • expires_at string

    The datetime when the referral connection request expires