# TrakRF Docs

> RFID Asset Tracking Platform

This file contains links to documentation sections following the llmstxt.org standard.

## Table of Contents

- [API docs](https://docs.preview.trakrf.id/docs/api/README.md): The TrakRF public REST API lets integrators read and write the same assets, locations, and scan events the first-party web app uses — via API-key a...
- [Authentication](https://docs.preview.trakrf.id/docs/api/authentication.md): The TrakRF API uses the **OAuth2 `client_credentials`** flow. You mint a long-lived `client_id` + `client_secret` pair once from the web app, excha...
- [Changelog](https://docs.preview.trakrf.id/docs/api/changelog.md): This log records changes to the TrakRF public API under `/api/v1/` that affect integrators. Entries follow the [Keep a Changelog](https://keepachan...
- [Data model: master sync and scan data](https://docs.preview.trakrf.id/docs/api/data-model.md): The TrakRF public API surfaces two categories of data and treats them differently on writes. Knowing which category a field falls into tells you wh...
- [Date fields](https://docs.preview.trakrf.id/docs/api/date-fields.md): Every timestamped resource in the TrakRF v1 API uses the same two effective-date fields: `valid_from` and `valid_to`. This page describes their sha...
- [Design notes](https://docs.preview.trakrf.id/docs/api/design-notes.md): These are choices we made on purpose, with reasons. Some look weird at first. If something in the API surprises you and you find yourself thinking ...
- [Errors](https://docs.preview.trakrf.id/docs/api/errors.md): Every non-2xx response from the TrakRF API returns a JSON body in a consistent error envelope. This page catalogs the error types you'll see and re...
- [HTTP method coverage](https://docs.preview.trakrf.id/docs/api/http-method-coverage.md): Two HTTP methods are intentionally **not** enumerated per path in the [OpenAPI reference](/api) — they're handled uniformly across every endpoint, ...
- [ID format](https://docs.preview.trakrf.id/docs/api/id-format.md): Every surrogate id on the TrakRF v1 API — primary keys (`id`), foreign-key references (`parent_id`, `location_id`, `asset_id`, `tag_id`, `org_id`),...
- [Pagination, filtering, sorting](https://docs.preview.trakrf.id/docs/api/pagination-filtering-sorting.md): All list endpoints in the TrakRF v1 API follow the same shape: offset-based pagination, repeatable filters, and comma-separated sort fields. This p...
- [API clients (Postman, Insomnia, Bruno, Hoppscotch)](https://docs.preview.trakrf.id/docs/api/postman.md): Postman, Insomnia, Bruno, and Hoppscotch all import an OpenAPI spec from a
- [Private endpoints](https://docs.preview.trakrf.id/docs/api/private-endpoints.md): :::caution Internal endpoints
- [Quickstart](https://docs.preview.trakrf.id/docs/api/quickstart.md): Goes from "I have API credentials" to "I called the TrakRF API and got a `200` back" in about ten minutes, with nothing but an HTTP client. If you ...
- [Rate limits](https://docs.preview.trakrf.id/docs/api/rate-limits.md): The TrakRF API applies a per-key rate limit to protect the shared service from runaway integrations. Normal customer traffic is well below the limi...
- [Resource identifiers](https://docs.preview.trakrf.id/docs/api/resource-identifiers.md): Every asset and location has two identifiers. The integer `id` is **canonical at the URL surface** — server-assigned, immutable, and the form path-...
- [Versioning](https://docs.preview.trakrf.id/docs/api/versioning.md): The TrakRF API uses URL-path versioning (`/api/v1/`) with a strong stability commitment: within a major version, changes are **additive only**. Thi...
- [Webhooks](https://docs.preview.trakrf.id/docs/api/webhooks.md): TrakRF can push an event to an HTTPS endpoint you host whenever an asset moves to a different location — the push alternative to polling [`GET /api...
- [Assets](https://docs.preview.trakrf.id/docs/app-tour/assets.md): Create, view, and track asset records.
- [Authoring the App Tour](https://docs.preview.trakrf.id/docs/app-tour/authoring.md): How to regenerate or refresh the App Tour docs section.
- [Geofence defaults](https://docs.preview.trakrf.id/docs/app-tour/geofence-defaults.md): Org-wide geofence tuning applied to every portal.
- [Help](https://docs.preview.trakrf.id/docs/app-tour/help.md): Quick answers to common questions.
- [App Tour](https://docs.preview.trakrf.id/docs/app-tour.md): Visual walk-through of every screen in the TrakRF web app.
- [Live Reads](https://docs.preview.trakrf.id/docs/app-tour/live-reads.md): Watch tag reads arrive in real time.
- [Locate](https://docs.preview.trakrf.id/docs/app-tour/locate.md): Find a specific item by walking the area with a handheld reader.
- [Locations](https://docs.preview.trakrf.id/docs/app-tour/locations.md): Create and organize the places where assets live.
- [Outputs](https://docs.preview.trakrf.id/docs/app-tour/outputs.md): Configure output devices triggered by geofence events.
- [Readers](https://docs.preview.trakrf.id/docs/app-tour/readers.md): Register and manage fixed RFID readers.
- [Reports](https://docs.preview.trakrf.id/docs/app-tour/reports.md): View asset location reports and movement history.
- [Scan](https://docs.preview.trakrf.id/docs/app-tour/scan.md): Read RFID tags or barcodes and reconcile them against a list.
- [Settings](https://docs.preview.trakrf.id/docs/app-tour/settings.md): Configure device and application settings.
- [Using the API](https://docs.preview.trakrf.id/docs/getting-started/api.md): This is the front door for the API track. It takes you from "I have API credentials" to "I called the TrakRF API and got a `200` back" using only s...
- [Getting started](https://docs.preview.trakrf.id/docs/getting-started.md): TrakRF can be used two ways — through the first-party web app with a handheld reader, or through the REST API from your own code. Pick the track th...
- [Using the app](https://docs.preview.trakrf.id/docs/getting-started/ui.md): Welcome to TrakRF — the RFID asset tracking platform built for handheld readers and the browser.
- [Fixed reader setup](https://docs.preview.trakrf.id/docs/integrations/fixed-reader-setup.md): TrakRF's current focus is the handheld scanner workflow. The platform data model and ingest pipeline are carried over from prior fixed-reader deplo...
- [Integrations](https://docs.preview.trakrf.id/docs/integrations.md): This section will cover the non-REST-API integration paths into TrakRF.
- [MQTT message format](https://docs.preview.trakrf.id/docs/integrations/mqtt-message-format.md): MQTT is the ingest path TrakRF inherits from prior fixed-reader deployments — the schema and processing pipeline that backs the handheld scan flow ...
- [Release notes](https://docs.preview.trakrf.id/docs/release-notes.md): What changed in the TrakRF app, newest first.
- [Asset Management](https://docs.preview.trakrf.id/docs/user-guide/asset-management.md): Register assets, scan them, save the results, and review history.
- [Location Tracking](https://docs.preview.trakrf.id/docs/user-guide/location-tracking.md): Monitor asset locations in real time using RFID zone detection.
- [Organization & Team Management](https://docs.preview.trakrf.id/docs/user-guide/organization-management.md): Everything covered on this page lives in the **account menu**, not the left sidebar. Click the avatar button in the top-right corner of the app (it...
- [Reader Setup](https://docs.preview.trakrf.id/docs/user-guide/reader-setup.md): Pair a CS108 handheld RFID reader with TrakRF over Web BLE.
- [Reports & Exports](https://docs.preview.trakrf.id/docs/user-guide/reports-exports.md): Generate reports and export data from the TrakRF platform.