Skip to main content

Client API

API endpoints used to manage client companies inside the RMS.

Endpoints Overview

MethodEndpointDescriptionAccess
GET/api/clientsFetch all clientsclient:read
POST/api/clientsCreate new clientclient:create
GET/api/clients/:idFetch a specific clientclient:read
PUT/api/clients/:idUpdate clientclient:update
DELETE/api/clients/:idDelete clientclient:delete

GET /api/clients

Fetch all clients.
Access: client:read
router.get(
  '/',
  protect,
  requirePermission('client', 'read'),
  getClients
);

POST /api/clients

Create a new client.
Access: client:create
router.post(
  '/',
  protect,
  requirePermission('client', 'create'),
  createClient
);

GET /api/clients/:id

Fetch a specific client.
Access: client:read
router.get(
  '/:id',
  protect,
  requirePermission('client', 'read'),
  getClient
);

PUT /api/clients/:id

Update an existing client.
Access: client:update
router.put(
  '/:id',
  protect,
  requirePermission('client', 'update'),
  updateClient
);

DELETE /api/clients/:id

Delete a client.
Access: client:delete
router.delete(
  '/:id',
  protect,
  requirePermission('client', 'delete'),
  deleteClient
);