REST API
REST API
FastLinkIt provides a comprehensive REST API for programmatic access to all features.
Authentication
The API supports three authentication methods:
- JWT Bearer Token — obtain via
POST /api/auth/login - API Key — pass via
X-Api-Keyheader - Cookie Auth — for Blazor UI (automatic)
API Keys
Generate API keys at Account → API Keys:
- Enter a name for the key
- Optionally set an expiration date
- Select scopes — which API services the key can access:
links— short linksqrcodes— QR codesgeoip— IP geolocationcontacts— contact managementcontact-groups— contact groupsmailing— email campaignsorganizer— booking systempayments-read— read payment datapayment-api— create checkoutswebhooks— webhook managementsupport— ticket systemticket-submit— external ticket submissionfundraising— campaigns
- Leave all scopes unchecked for full access
- Click Generate — the key is shown once, copy it immediately
Keys use the format fli_ followed by 32 random bytes.
API Documentation
Interactive API docs are available at /scalar/v1 (development) with the OpenAPI spec at /openapi/v1.json.
Rate Limits
API usage is subject to your subscription plan's link/QR code limits. The API returns 403 with an upgrade message when plan limits are reached.
Available Endpoints
| Area | Endpoints |
|---|---|
| Links | CRUD, stats |
| QR Codes | CRUD |
| Contacts | CRUD, search |
| Contact Groups | CRUD, members |
| Mailing | Create, send, list |
| Organizer | Planners, templates, slots, bookings |
| Payments | Products, checkout, transactions, refunds, webhooks |
| Fundraising | Campaigns, donations |
| Support | Tickets, messages |
| GeoIP | IP lookup |