CitoHRCitoHR
API Reference

Policies API

Access and manage company policies and documents through the CitoHR API.

Get Policies

Retrieve policies with filtering and pagination.

GET /api/policies

Query parameters:

  • page - Page number (default: 1)
  • limit - Items per page (default: 10)
  • search - Search policies by title (optional)
  • category - Filter by category (optional)
  • status - Filter by status: DRAFT, PUBLISHED, ARCHIVED (optional)
  • sortBy - Sort field (default: createdAt)
  • sortOrder - Sort order: asc or desc (default: desc)

Authorization: Requires valid session.

Get Policy by ID

Retrieve a specific policy by ID. Automatically marks the policy as read for the current user.

GET /api/policies/{id}

Mark Policy as Read

Mark a policy as read for the current user.

POST /api/policies

Request body: 

{
  "policyId": "policy-id"
}