---
title: "Get shortlist candidates"
method: GET
path: "/api/v1/sub-out/{referralId}/shortlist"
tags: ["sub-out"]
---

# Get shortlist candidates

`GET /api/v1/sub-out/{referralId}/shortlist`

## Request

- Base URL: `http://localhost:3002`
- URL: `http://localhost:3002/api/v1/sub-out/{referralId}/shortlist`
- Auth: HTTP bearer

Returns the originating captain's preferred shortlist candidates for a referral, with a financial breakdown per candidate.

## Path parameters

- `referralId` string, required

## Response `200`

List of shortlist candidates

- object
  - `data` SubOutShortlistCandidate[], required
    - `tenantId` string, required
    - `displayName` string, required
    - `slug` string, required
    - `captainId` string, nullable, required
    - `relationshipId` string, required
    - `priority` number, required
    - `breakdown` object, required
      - `grossEarnings` number, required
      - `referralFee` number, required
      - `referralFeePercent` number, required
      - `platformFee` number, required
      - `platformFeeRate` number, required
      - `netEarnings` number, required

## Other responses

- `400`: Request body or query parameters failed validation.
- `401`: Authentication required, or the bearer token is missing or invalid.
- `404`: The requested resource does not exist (existence is not leaked).

---

[API](https://skmtc.dev/chartercaptain/apis/charter-captain-api.md) · [All operations](https://skmtc.dev/chartercaptain/apis/charter-captain-api/llms.txt) · [OpenAPI document](https://skmtc.dev/chartercaptain/apis/charter-captain-api/revisions/1ffea1113adb?raw)