Endpoint reference
Quick reference for all HGV Traders API v1 routes.
Public read (no authentication)
| Method | Path | Purpose |
|---|---|---|
GET | /api/v1/jobs | Search published jobs |
GET | /api/v1/jobs/{id} | Job detail |
GET | /api/v1/events | Search published events |
GET | /api/v1/events/{id} | Event detail |
GET | /api/v1/posts | Search published articles |
GET | /api/v1/posts/{id} | Article detail |
See Public read. Rate limit: 60 requests/minute per IP.
Authentication
| Method | Path | Purpose |
|---|---|---|
POST | /api/v1/auth | Exchange credentials for a bearer token |
Bearer — profile and account
| Method | Path | Purpose |
|---|---|---|
GET | /api/v1/me | Current user profile |
GET | /api/v1/accounts | Organisation details |
PATCH | /api/v1/accounts | Update org profile (ADMIN) |
POST | /api/v1/notification_tokens | Register push token |
Bearer — dealer write and read
| Method | Path | Purpose |
|---|---|---|
GET | /api/v1/stock | List org stock |
POST | /api/v1/stock | Create draft stock |
GET/PATCH | /api/v1/stock/{id} | Get / update stock |
POST | /api/v1/stock/{id}/publish | Publish |
POST | /api/v1/stock/{id}/unpublish | Unpublish |
POST | /api/v1/stock/{id}/sold | Mark sold |
POST | /api/v1/uploads | Upload a stock image (multipart, max 4MB) |
POST | /api/v1/uploads/presign | Presigned upload for files over 4MB — see Image uploads |
GET/POST | /api/v1/jobs | List org jobs / create job |
GET/PATCH | /api/v1/jobs/{id} | Get / update job (bearer) |
POST | /api/v1/jobs/{id}/publish | Publish job |
POST | /api/v1/jobs/{id}/unpublish | Unpublish job |
GET | /api/v1/enquiries | List enquiries |
GET | /api/v1/enquiries/{id} | Enquiry detail |
Write routes: 120 requests/minute per user. Guides: Stock, Jobs (dealer), Enquiries.
Outbound webhooks
Platform events are pushed to URLs you configure in the dashboard — not REST endpoints. See Webhooks.
Full schemas
The interactive API Reference lists request and response schemas for every route.