Skip to content

Architecture

API Reference

REST endpoints exposed by the Go API.

Buyer documentation is provided in English.

All endpoints are prefixed with /api/v1 and return the standard envelope. Authenticated routes expect an Authorization header carrying a bearer token.

Authentication

MethodPathDescription
POST/auth/registerCreate an owner account and organization
POST/auth/loginExchange credentials for tokens
POST/auth/forgot-passwordRequest a password reset
POST/auth/reset-passwordConsume a reset token
POST/auth/change-passwordChange the signed in password
GET/auth/meCurrent user and organization

Jobs

MethodPathDescription
GET/jobsPaginated list with filters
POST/jobsCreate a job
GET/jobs/{id}Job detail
PUT/jobs/{id}Update a job
PATCH/jobs/{id}/statusChange status
DELETE/jobs/{id}Soft delete

Candidates

MethodPathDescription
GET/candidatesPaginated list with score filters
GET/candidates/{id}Candidate with resume and analysis
PATCH/candidates/{id}/statusMove through the pipeline
DELETE/candidates/{id}Soft delete candidate
POST/jobs/{id}/resumesBulk resume upload, multipart
POST/jobs/{id}/candidates/importCSV profile import, multipart
The full request and response contract is in docs/API.md in the template package. Lite does not serve Swagger UI.