RICHESTHOUSE

API Documentation

Home

Version

0.1.0

Endpoints

20

OpenAPI JSON

/api/docs

System

Platform health endpoints

get
/api/health

Check API health

get
/api/db/health

Check SQL Server connectivity

Auth

Development authentication endpoints

post
/api/auth/login

Login with a legacy flowman account

body
post
/api/auth/logout

Logout current session

get
/api/auth/me

Return current user

Dashboard

Dashboard summaries and charts

get
/api/dashboard/summary

Get dashboard counters

get
/api/dashboard/jobs/latest

Get latest jobs

query:limit
get
/api/dashboard/jobs/status-stats

Get job counts grouped by status

Jobs

Job listing, details, assignment and options

get
/api/jobs

List jobs with filters and pagination

query:keywordquery:statusquery:sortquery:pagequery:pageSize
get
/api/jobs/{jobId}

Get one job

path:jobId*
get
/api/jobs/statuses

List job statuses

get
/api/flowmen

List flowmen

patch
/api/jobs/{jobId}/assignment

Assign a flowman to a job

path:jobId*body

Check-ins

Location check-in endpoints

post
/api/checkins

Create a job check-in

body
get
/api/checkins/my-history

List current user's check-in history

query:userIdquery:pagequery:pageSize
get
/api/jobs/{jobId}/checkins

List check-ins for one job

path:jobId*

Images

Job image gallery and upload endpoints

get
/api/processes

List image process options

get
/api/jobs/{jobId}/images

List images for one job

path:jobId*query:process
post
/api/jobs/{jobId}/images

Upload images for one job

path:jobId*body
delete
/api/images

Delete selected images

body