REST API Reference

Overview

The TendedLoop REST API provides programmatic access to all platform capabilities. Every response follows a consistent JSON envelope format. All data is tenant-scoped — authenticated requests can only access data belonging to their tenant.

The API serves three categories of consumers: public endpoints (anonymous QR feedback, status pages), authenticated endpoints (tasks, dashboards, admin), and integration endpoints (API keys, webhooks).

Base URL & Response Format

Base URL

https://api.tendedloop.com

Response Envelope

Every response uses a consistent JSON envelope. The success field indicates whether the request succeeded. On success, data contains the result. On failure, error and code describe what went wrong.

Success response

{
  "success": true,
  "data": {
    "id": "clx9abc...",
    "name": "Headquarters",
    "createdAt": "2026-01-15T10:30:00.000Z"
  }
}

Error response

{
  "success": false,
  "error": "QR code not found or not configured",
  "code": "NOT_FOUND"
}

Authentication

TendedLoop supports two authentication methods. For a detailed guide, see the Authentication documentation.

JWT Bearer Token

Obtain a token by logging in via POST /api/auth/login. Include it in subsequent requests:

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

API Key

Generate an API key in the dashboard or via the API. Include it in the X-API-Key header:

X-API-Key: tl_k_abc123...

Pagination

List endpoints support cursor-based pagination via query parameters.

Paginated response

{
  "success": true,
  "data": [...],
  "total": 142,
  "page": 1,
  "pageSize": 20,
  "totalPages": 8
}

Core Endpoints

The most commonly used endpoints, organized by module. All paths are relative to the base URL.

Feedback (Public)

Example: Submit feedback

curl -X POST https://api.tendedloop.com/api/feedback \
  -H "Content-Type: application/json" \
  -d '{
    "qrCode": "TL-ABC123",
    "rating": 4,
    "comment": "Very clean, well maintained",
    "issues": []
  }'

Status (Public)

Tasks (JWT)

Example: Update task status

curl -X PATCH https://api.tendedloop.com/api/tasks/clx9abc.../status \
  -H "Authorization: Bearer eyJhbGci..." \
  -H "Content-Type: application/json" \
  -d '{ "status": "DONE" }'

Dashboard (JWT, Manager+)

Admin: Buildings (JWT, Admin)

Admin: Amenities (JWT, Admin)

Admin: Users (JWT, Admin)

Admin: Webhooks (JWT, Admin)

Billing (JWT)

Rate Limiting

Rate limits are enforced per IP (public endpoints) or per tenant (authenticated endpoints). When exceeded, the API returns 429 Too Many Requests with the RATE_LIMITED error code.

Error Codes

Error responses include a machine-readable code field. Use this for programmatic error handling rather than parsing the error message.

Plan-Gated Features

Certain API features are only available on specific plans. Requests to plan-gated endpoints on lower plans return 403 with a descriptive error.

Full Endpoint Count

The API is organized into 15 registered modules plus 3 internal modules. Below is the full breakdown.

Plus 3 internal modules (alerts, routing, export) with no public routes.