---
title: "Gets the job referral hierarchy for a specific job"
method: GET
path: "/api/v1/jobs/{jobId}/referrals"
tags: ["JobReferral"]
---

# Gets the job referral hierarchy for a specific job

`GET /api/v1/jobs/{jobId}/referrals`

## Request

- Base URL: `https://api.fireserviceusa.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.fireserviceusa.com/api/v1/jobs/{jobId}/referrals`
- Auth: none declared

## Path parameters

- `jobId` integer, required

## Response `200`

Success

- JobReferralHierarchyViewModel: View model for job referral hierarchy
  - `JobId` integer: The job ID
  - `JobNumber` string, nullable: The job number
  - `JobDescription` string, nullable: The job description
  - `Accounts` ReferralAccountViewModel[], nullable: The list of referral accounts
    - `AccountId` integer: The account ID
    - `DisplayName` string, nullable: The display name
    - `AccountType` string, nullable: The account type
    - `ReferralType` string, nullable: The referral type
    - `CommissionRate` number, double, nullable: The commission rate
    - `AssignmentDate` string, date-time: The assignment date
    - `Level` integer: The level in hierarchy
    - `HierarchyPathNames` string, nullable: The hierarchy path names
    - `HierarchyPathIds` string, nullable: The hierarchy path IDs
    - `IsDirectReferral` boolean: Whether this is a direct referral
    - `IsEnrolledInLoyaltyRewardsProgram` boolean: Whether the referring entity is enrolled in the loyalty rewards program
    - `IsActive` boolean: Whether the account is active
  - `RevenueSummary` RevenueSummaryViewModel: View model for revenue summary
    - `TotalJobRevenue` number, double: The total job revenue
    - `TotalCommissionPaid` number, double: The total commission paid
    - `NumberOfCredits` integer: The number of credits
  - `Statistics` ReferralStatisticsViewModel: View model for referral statistics
    - `TotalReferrers` integer: The total number of referrers
    - `DirectReferrals` integer: The number of direct referrals
    - `IndirectReferrals` integer: The number of indirect referrals
    - `MaxDepth` integer: The maximum depth of the hierarchy
    - `AverageCommissionRate` number, double: The average commission rate

---

[API](https://skmtc.dev/fireserviceusa/apis/fireservice-usa-p2-api.md) - [All operations](https://skmtc.dev/fireserviceusa/apis/fireservice-usa-p2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fireserviceusa/apis/fireservice-usa-p2-api/revisions/96ea2ea68d87?raw)