Variables and fragments

Variables

Variables allow you to pass dynamic values to your queries and mutations, making them reusable.

Using variables

Define variables in your query and pass them separately:

query GetDeal($id: ID!) {
  deal(id: $id) {
    id
    friendlyId
  }
}

Variables:

{
  "id": "123"
}

Variable types

GraphQL supports various variable types:

ID! - Required ID
String - Optional string
Int - Integer
Float - Floating point number
Boolean - True/false
Custom input types

Example with multiple variables

query GetDeals($first: Int, $sortDirection: SortDirection) {
  deals(first: $first, sortDirection: $sortDirection) {
    edges {
      node {
        id
        friendlyId
      }
    }
  }
}

Variables:

{
  "first": 10,
  "sortDirection": "DESC"
}

Fragments

Fragments allow you to reuse field selections across multiple queries.

Basic fragment

fragment BorrowerFields on Borrower {
  id
  personalInformation {
    firstName
    lastName
    email
  }
}

query GetDeal {
  deal(id: "123") {
    id
    borrowers {
      edges {
        node {
          ...BorrowerFields
        }
      }
    }
  }
}

Multiple fragments

You can use multiple fragments in a single query:

fragment BorrowerFields on Borrower {
  id
  personalInformation {
    firstName
    lastName
  }
}

fragment IncomeFields on Income {
  statedMonthlyAmount
  payPeriodFrequency
}

query GetDeal {
  deal(id: "123") {
    id
    borrowers {
      edges {
        node {
          ...BorrowerFields
          incomes {
            edges {
              node {
                ...IncomeFields
              }
            }
          }
        }
      }
    }
  }
}

Selecting loan fields

Request the fields you need directly on a loan:

query GetLoan {
  loan(id: "123") {
    id
    loanPurpose
    purchasePrice
    maxLoanAmount
  }
}

Inline fragments

Use inline fragments to select fields that only exist on a specific implementation of an interface. For example, institutionName is only available on assets that implement FinancialAccountAsset:

query GetBorrowerAssets($id: ID!) {
  borrower(id: $id) {
    id
    assets {
      id
      amount
      ... on FinancialAccountAsset {
        institutionName
      }
    }
  }
}

Best practices

Use variables for dynamic values - Never hardcode IDs or filters
Create reusable fragments - Define common field selections once
Name fragments descriptively - Use clear, descriptive names
Keep fragments focused - Don’t create overly large fragments

Common patterns

Reusable borrower fragment

fragment BorrowerDetails on Borrower {
  id
  personalInformation {
    firstName
    lastName
    email
    phoneNumbers {
      number
      type
    }
  }
  incomes {
    edges {
      node {
        statedMonthlyAmount
        payPeriodFrequency
      }
    }
  }
  assets {
    id
    amount
    ... on FinancialAccountAsset {
      institutionName
    }
  }
}

Using in multiple queries

query GetDeal($id: ID!) {
  deal(id: $id) {
    id
    borrowers {
      edges {
        node {
          ...BorrowerDetails
        }
      }
    }
  }
}

query GetBorrower($id: ID!) {
  borrower(id: $id) {
    ...BorrowerDetails
  }
}

GRAPHQL GUIDES

API REFERENCE

Variables

Using variables

Variable types

Example with multiple variables

Fragments

Basic fragment

Multiple fragments

Selecting loan fields

Inline fragments

Best practices

Common patterns

Reusable borrower fragment

Using in multiple queries

​Variables

​Using variables

​Variable types

​Example with multiple variables

​Fragments

​Basic fragment

​Multiple fragments

​Selecting loan fields

​Inline fragments

​Best practices

​Common patterns

​Reusable borrower fragment

​Using in multiple queries

Variables

Using variables

Variable types

Example with multiple variables

Fragments

Basic fragment

Multiple fragments

Selecting loan fields

Inline fragments

Best practices

Common patterns

Reusable borrower fragment

Using in multiple queries