---
title: "Search Referral Report"
method: POST
path: "/v1/workspaces/{workspace_id}/referral-report/search"
tags: ["matter-attribution"]
---

# Search Referral Report

`POST /v1/workspaces/{workspace_id}/referral-report/search`

## Request

- Base URL: `https://api.ender.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.ender.au/v1/workspaces/{workspace_id}/referral-report/search`
- Auth: HTTP bearer

## Path parameters

- `workspace_id` string, uuid, required

## Request body

- ReferralReportSearch: From the first of a month (`start`) to the day before `end`. `end` is usually the first of a month. Another day ends the last month early. With `compare_through`, the last complete day, rows are also split by whether they fall in the comparison windows: that day's month through it and the same days of the month before (all of it when shorter), as the firm report's `compared` rows are.
  - `start` string, date, required
  - `end` string, date, required
  - `compare_through` string, date, nullable

## Response `200`

Successful Response

- ReferralReport
  - `start` string, date, required
  - `end` string, date, required
  - `compare_through` string, date, nullable, required
  - `rows` ReferralReportRow[], required
    - `matter_id` string, uuid, required
    - `matter_name` string, required
    - `matter_code` string, required
    - `matter_slug` string, required
    - `team_member` boolean, required
    - `referrer_id` string, uuid, nullable, required
    - `referrer_name` string, nullable, required
    - `referrer_organisation` string, nullable, required
    - `bdm_user_id` string, uuid, nullable, required
    - `bdm_name` string, nullable, required
    - `month` string, date, required
    - `introduced` boolean, required
    - `posted_wip` string, decimal, required
    - `drawings` string, decimal, required
    - `compared` boolean, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/ender/apis/ender-backend.md) - [All operations](https://skmtc.dev/ender/apis/ender-backend/llms.txt) - [OpenAPI document](https://skmtc.dev/ender/apis/ender-backend/revisions/bf4373130521?raw)