Introduction
Everything you need to integrate RFID attendance, access control, and device management into your application.
Welcome
Thanks for building with us
Our API gives you programmatic access to everything you can do in the dashboard — manage devices, users, RFID cards, gate passes, and track attendance in real time. Whether you're building a custom front-end, syncing data to your HR system, or automating workflows, this is the place to start.
Fast to start
Make your first API call in under 5 minutes
Secure by default
HMAC-signed webhooks, JWT auth, and tenant isolation
Multi-tenant
Every request is scoped to your organization
What is this API?
A REST API for attendance & access control
This is a REST API that exposes your organization's attendance, device, and access control data. It speaks JSON over HTTPS and uses JWT bearer tokens for authentication.
Alongside the API you get webhooks — real-time HTTP callbacks when things happen (a user checks in, a device goes offline, an RFID card request is approved).
What you can build
A quick tour of the surface area
Device Management
Register, monitor, and control RFID scanners and gate readers.
User Management
Create, update, and manage your organization members.
RFID Cards
Issue, assign, and revoke RFID card access for users.
Attendance Tracking
Read real-time check-ins, check-outs, and daily summaries.
Real-time Webhooks
Subscribe to events like check-ins and device status.
Notifications
Configure channels and events for automated alerts.
How it fits together
A quick architecture overview
Your app talks to our REST API to read and write data. In parallel, our webhook service POSTs events to your server whenever something happens — so you never have to poll.
┌──────────────┐ HTTPS/JSON ┌──────────────────┐
│ Your App │ ─────────────────────► │ REST API │
│ (Server/SPA) │ ◄───────────────────── │ /v1/* │
└──────┬───────┘ └────────┬─────────┘
│ │
│ │
│ HTTPS/JSON (webhook) │
│ ◄──────────────────────┐ │
│ │ │
│ ┌──────┴──────┐ ┌──────┴─────────┐
│ │ Webhooks │ │ Database │
└────────────────►│ Service │◄──│ (MongoDB) │
└──────┬──────┘ └────────────────┘
│
│ subscribes to events
▼
┌──────────────┐
│ Event Bus │
└──────────────┘REST calls for CRUD operations
Webhooks push events to you
Every request scoped to your tenant
Quick links
Jump to what you need
Conventions
Things that are true across the whole API
Base URL
All REST endpoints live under a single versioned base path.
https://api.yourapp.com/v1Authentication
Every request must include a bearer JWT in the Authorization header.
Authorization: Bearer <your_token>Request format
Send JSON with the Content-Type header on any request with a body.
Content-Type: application/jsonSuccess responses
All successful responses follow a consistent envelope.
{ "success": true, "data": { ... } }Error responses
Errors always include success: false and a human-readable message.
{ "success": false, "error": "..." }Dates & times
All timestamps are ISO 8601 in UTC.
2026-01-15T10:30:45.123ZIDs
Entity IDs are MongoDB ObjectIds represented as 24-character hex strings.
507f1f77bcf86cd799439011Need help?
We're here to help
Read the docs
Browse the full reference for every endpoint
View API ReferenceTry it out
Start with a simple request in under 5 minutes
Go to QuickstartContact support
Reach the team with your tenant ID
Email SupportYou're all set
Head over to Quickstart to make your first call, or dive into Authentication if you already have an API key.