Skip to main content

API Documentation

Interactive OpenAPI reference for the LVL Up Performance REST API. Explore endpoints, inspect schemas, and test requests with bearer-token auth. API access is included on the Storming plan and above — the raw spec is served at /openapi.json.

Stable endpoints (v1)

Build against /api/v1/. These are the versioned, read-only endpoints we keep stable. Everything else in the reference below is the application's own interface and can change without notice.

  • GET /api/v1/employees

    Paginated employees for the authenticated account.

    Query: status (pending | active | inactive), limit (default 50, max 200), offset

  • GET /api/v1/goals

    Paginated goals for the authenticated account.

    Query: status (e.g. not_started, in_progress, completed), limit (default 50, max 200), offset

  • GET /api/v1/feedback

    Paginated feedback for the authenticated account.

    Query: page (default 1), limit (default 20, max 100)

  • GET /api/v1/recognition

    Paginated recognitions for the authenticated account.

    Query: limit (default 50, max 200), offset

  • GET /api/v1/reviews

    Paginated performance review cycles for the authenticated account.

    Query: limit (default 50, max 200), offset

Authentication

Every v1 request needs an API key sent as a bearer token: Authorization: Bearer lvl_... Keys are scoped to one account, and responses only ever contain that account's data. Results are paginated — read the per-endpoint limits above rather than assuming a full dump.

Loading API Documentation...