Quickstart
Get up and running in 5 minutes. Fetch users, register a device, and subscribe to webhooks.
Prerequisites
What you need before starting
Before you make your first request, make sure you have:
An account
Sign up at yourapp.com with your organization email
API access
Your account must have API access enabled
A tool to test
curl, Postman, or any HTTP client
curl from your terminal.Get your API key
Your key authenticates every request
Log in and go to Settings → API Keys
Click 'Generate New Key' and give it a name (e.g. 'My Integration')
Copy it immediately — the full key is shown only once
Add it to your .env file, never commit it to git
Your .env file
API_URL=https://api.yourapp.com/v1
API_KEY=sk_live_abc123def456ghi789jkl012mno345Make your first call
Fetch your organization's users
Every request needs the Authorization header with your key. Let's list the users in your organization.
curl -X GET "https://api.yourapp.com/v1/users?limit=10" \
-H "Authorization: Bearer sk_live_abc123def456ghi789jkl012mno345" \
-H "Content-Type: application/json"{
"success": true,
"data": {
"users": [
{
"_id": "507f1f77bcf86cd799439011",
"firstName": "John",
"lastName": "Doe",
"email": "john@example.com",
"role": "STAFF",
"isActive": true,
"createdAt": "2026-01-10T09:00:00.000Z"
}
],
"pagination": {
"total": 42,
"limit": 10,
"offset": 0
}
}
}Common operations
The four requests you'll make most
/usersList all users in your organization
curl -X GET "https://api.yourapp.com/v1/users?limit=50" \
-H "Authorization: Bearer $API_KEY"/usersCreate a new user
curl -X POST "https://api.yourapp.com/v1/users" \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"firstName": "Jane",
"lastName": "Smith",
"email": "jane@example.com",
"phone": "+15550001234",
"role": "STAFF"
}'/devicesList all devices
curl -X GET "https://api.yourapp.com/v1/devices" \
-H "Authorization: Bearer $API_KEY"/logsFetch recent activity
curl -X GET "https://api.yourapp.com/v1/logs?limit=20&status=ON_TIME" \
-H "Authorization: Bearer $API_KEY"Full endpoint reference
Every endpoint, parameter, and response shape is documented in the REST API reference.
Set up webhooks
Get real-time event notifications
Instead of polling for changes, subscribe to webhooks. We'll POST a signed JSON payload to your URL whenever an event fires.
Create a public HTTPS route that accepts POST requests
In Settings → API Keys, add your URL and pick events
Validate the X-Webhook-Signature header on every request
Minimal receiver (Node.js)
const crypto = require('crypto');
const express = require('express');
const app = express();
app.post(
'/webhooks/rfid',
express.raw({ type: 'application/json' }),
(req, res) => {
const signature = req.headers['x-webhook-signature'];
const expected = crypto
.createHmac('sha256', process.env.WEBHOOK_SECRET)
.update(req.body)
.digest('hex');
if (
!signature ||
!crypto.timingSafeEqual(
Buffer.from(signature),
Buffer.from(expected)
)
) {
return res.status(401).end();
}
const { event, data } = JSON.parse(req.body.toString());
console.log('Received event:', event, data);
res.status(200).json({ received: true });
}
);
app.listen(3000);Full webhook guide
Signatures, retries, available events, and best practices are in the Webhooks documentation.
Next steps
Keep building
Authentication
Dive deeper into API keys and JWTs
REST API Reference
Full endpoint reference
Webhooks
Real-time event delivery
Error Codes
Handle failures gracefully
You're all set
You've made your first call and know how to wire up webhooks. Head to the REST API reference to see every endpoint you can use.