> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kuahr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an appraisal cycle

> Opens a cycle and seeds a review for every active employee. Requires `performance:write`.



## OpenAPI

````yaml https://api.kuahr.com/openapi/v1.json post /v1/performance/appraisal-cycles
openapi: 3.1.1
info:
  title: Kua API
  description: >-
    The Kua developer API — payroll, wallets, and payments for your own company.


    Authenticate with an API key issued from **Settings → API keys** in the
    dashboard, sent in the `X-Api-Key` header. Every request is scoped to the
    company that owns the key. Base URL: `https://api.kuahr.com` (all endpoints
    are versioned under `/v1`).
  version: v1
servers:
  - url: https://api.kuahr.com
    description: Production
security:
  - ApiKey: []
tags:
  - name: Payroll
    description: List and create payroll runs.
  - name: Employees
    description: Add people to your company.
  - name: Events
    description: The company event timeline (also delivered via webhooks).
  - name: Webhooks
    description: Register endpoints and inspect deliveries.
  - name: Test data
    description: Manage sandbox (test-mode) data.
  - name: Leave
    description: >-
      Time-off types, requests, balances, and allocations (requires the Leave
      add-on).
  - name: Advances
    description: Salary advances (requires the Salary advance add-on).
  - name: Performance
    description: OKRs, appraisals, and promotions (requires the Performance add-on).
paths:
  /v1/performance/appraisal-cycles:
    post:
      tags:
        - Performance
      summary: Create an appraisal cycle
      description: >-
        Opens a cycle and seeds a review for every active employee. Requires
        `performance:write`.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1CreateCycleRequest'
            example:
              name: H2 2026 review
              opensOn: '2026-10-01'
              closesOn: '2026-10-31'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppraisalCycleDto'
              example:
                id: 0d1e2f3a-0000-0000-0000-000000000001
                name: H2 2026 review
                opensOn: '2026-10-01'
                closesOn: '2026-10-31'
                status: Open
                createdAt: '2026-09-15T09:00:00+00:00'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    V1CreateCycleRequest:
      required:
        - name
        - opensOn
        - closesOn
      type: object
      properties:
        name:
          type: string
        opensOn:
          type: string
          format: date
        closesOn:
          type: string
          format: date
    AppraisalCycleDto:
      required:
        - id
        - name
        - opensOn
        - closesOn
        - status
        - createdAt
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        opensOn:
          type: string
          format: date
        closesOn:
          type: string
          format: date
        status:
          type: string
          description: One of `Open`, `Closed`, `Cancelled`.
        createdAt:
          type: string
          format: date-time
      description: An appraisal cycle.
    ApiError:
      required:
        - code
        - message
      type: object
      properties:
        code:
          type: string
          description: >-
            A stable, machine-readable identifier you can branch on, e.g.
            `INSUFFICIENT_SCOPE`.
        message:
          type: string
          description: A human-readable explanation. May change; don't parse it.
      description: The standard error body returned for 4xx responses.
  securitySchemes:
    ApiKey:
      type: apiKey
      description: Your API key, e.g. `kua_live_…` (or `kua_test_…` in test mode).
      name: X-Api-Key
      in: header

````