Docs API Reference

Sale Data Status API

The ThoroughRepository API lets sales companies keep their online catalogues in sync with ThoroughRepository. Use it to show which lots have X-ray images and scope videos available, track study counts, approval status, and update timestamps.

The API is organized around REST. It accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and authentication.

Quick Start

  1. Obtain a bearer access token from ThoroughRepository.
  2. List your active sales with GET /api/inspections/sales.
  3. For a given sale, call GET /api/submissions/{saleId}/status to see status for every lot.
  4. Optionally, query a single lot with GET /api/submissions/{saleId}/{lot}/status.
BASE URL
https://api.thoroughrepository.com
Docs API Reference Sale Data Status

Authentication

The ThoroughRepository API uses bearer tokens to authenticate requests. You can view and manage your API keys in the ThoroughRepository Dashboard.

Your API keys carry many privileges, so be sure to keep them secure. Don't share your secret API keys in publicly accessible areas such as GitHub or client-side code.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Your API Key

Contact ThoroughRepository to obtain your API key. Replace YOUR_API_KEY with your actual key in all requests.

Required Headers

Header Example Required
Authorization Bearer YOUR_API_KEY Yes
Accept application/json Yes
AUTHENTICATED REQUEST 
1GET /api/inspections/sales HTTP/1.1
2Host: api.thoroughrepository.com
3Authorization: Bearer YOUR_API_KEY
4Accept: application/json
Docs API Reference Sale Data Status

Errors

ThoroughRepository uses conventional HTTP response codes to indicate the success or failure of an API request. In general: codes in the 2xx range indicate success, codes in the 4xx range indicate an error with the information provided, and codes in the 5xx range indicate an error with ThoroughRepository's servers.

ERROR RESPONSE 
1{
2  "error": {
3    "code": "invalid_sale_id",
4    "message": "No such sale exists."
5  }
6}
HTTP STATUS CODE SUMMARY
200 OK Everything worked as expected.
400 Bad Request The request was unacceptable, often due to missing a required parameter.
401 Unauthorized No valid API key provided.
404 Not Found The requested resource doesn't exist.
500 Server Error Something went wrong on ThoroughRepository's end. (These are rare.)
Docs API Reference Sale Data Status

All Sales - Names & IDs

GET /api/inspections/sales

Returns all of your sales that are currently active in ThoroughRepository, including each sale's display name and its saleId.

Returns

saleId string

Unique identifier for the sale.

saleName string

Display name of the sale.

RESPONSE 
1[
2  {
3    "saleId": "c74f0e4d-1e2a-...",
4    "saleName": "2026 Premier Yearling Sale"
5  },
6  {
7    "saleId": "9c3b8a6d-7291-...",
8    "saleName": "2026 Autumn Mixed Sale"
9  }
10]
Docs API Reference Sale Data Status

Sale - All Lots Status

GET /api/submissions/{saleId}/status

Returns the data status for every lot in a sale, including counts and review state for X-ray images and scope videos.

Path Parameters

saleId string required

The ID of the sale from /api/inspections/sales.

Status Values

Approved

Visible to vets during viewing window.

In Review

Submitted, not yet visible to vets.

Denied

Rejected by sale admin.

Draft

Uploaded but not submitted.

RESPONSE 
1[{
2  "saleId": "c74f0e4d-...",
3  "lot": "3",
4  "xrays": {
5    "hasData": true,
6    "status": "Approved",
7    "counts": 36
8  },
9  "scope": {
10    "hasData": true,
11    "status": "Approved"
12  }
13}]
Docs API Reference Sale Data Status

Sale - Single Lot Status

GET /api/submissions/{saleId}/{lot}/status

Returns the data status for a single horse (lot) in a sale. Uses the same schema as the sale status endpoint.

Path Parameters

saleId string required

The ID of the sale.

lot string required

Lot number within the sale.

RESPONSE 
1{
2  "saleId": "c74f0e4d-...",
3  "lot": "12",
4  "xrays": {
5    "hasData": true,
6    "status": "Approved",
7    "counts": 36
8  },
9  "scope": {
10    "hasData": true,
11    "counts": 1
12  }
13}
ThoroughRepository Documentation · 2025