Skip to content

API Reference

Gautam Kumar edited this page Apr 8, 2026 · 1 revision

API Reference

The Capuchin platform implements standard REST guidelines consuming and producing application/json strings. CORS rule: Currently allows all origins *. This limits credentials via explicit token distribution.

Authorizations

Include Header: Authorization: Bearer <$JWT> on restricted routes.

Auth Routes

POST /signup

  • Payload: {"email": "my@email.com", "password": "minimum_eight_chars"}
  • Success: 201 Created

POST /login

  • Payload: {"email": "my@email.com", "password": "minimum_eight_chars"}
  • Success: 200 OK - Return JSON maps { "token": "<JWT_STRING>" }
  • Errors: 401 Unauthorized

POST /logout

  • Header Required
  • Automatically writes string payload into Postgres block-list terminating JWT early.

Todo Routes (Requires Header)

GET /api/user/todo

Gets array of all contextually scoped Todos maps.

POST /api/user/todo

  • Payload: {"item": "Feed the cat", "completed": false}

PATCH /api/user/todo/:id

  • Payload: Conditionally updating either item or completed safely.

DELETE /api/user/todo/:id

  • Success: 200 OK {"message":"Todo deleted successfully"}
  • Error: 404 (If not found or not owner)

Clone this wiki locally