Aikorax Help · Developer Reference

API Documentation & OpenAPI Contract

Aikorax exposes a secure, tenant-isolated REST API powering our web, mobile, and third-party integrations. All API routes are prefixed with /api/v1.

1. Authentication

Aikorax supports two primary authentication schemes:

• Bearer JWT (Mobile & Integrations): Pass standard Bearer token in the Authorization header:

  Authorization: Bearer <token>

• Session Cookie (Web UI): Web clients authenticated via NextAuth send a secure HTTP-only session cookie automatically.

2. Tenant Isolation & Role-Based Access

Every authenticated request is scoped to the user’s active organization. Access permissions follow a strict role hierarchy:

• OWNER: Full administrative, billing, location, and data export access.
• ADMIN: Manages locations, inventory, floor plans, bookings, and members.
• STAFF: Front-desk check-in, event management, and day-to-day operations.
• MEMBER: Views assigned memberships, creates/cancels personal bookings, and submits support tickets.

3. Standard Response Format

All endpoints return consistent JSON response envelopes:

Success Response (HTTP 200 / 201):

{
  "success": true,
  "data": { ... }
}

Error Response (HTTP 4xx / 5xx):

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Human-readable explanation of what went wrong"
  }
}

4. Core Resource Routes

• GET /api/v1/locations — List workspace locations and active time zones.
• GET, POST /api/v1/bookings — Query availability and book desks or meeting rooms.
• POST /api/v1/bookings/:id/cancel — Safely cancel reservations with reason and audit trail.
• POST /api/v1/check-in — Fast QR and HMAC token verification for front-desk and desk check-in.
• GET, POST /api/v1/facility-issues — Report and track building, cleaning, and equipment maintenance.
• GET, POST /api/v1/support/tickets — Submit and track customer support requests with our platform team.

Questions & Integration Support

Building a custom hardware or software integration? Consult our Help Center, explore the in-app support portal, or contact engineering via our contact page.