Available API Endpoints
Flaree offers simple, secure endpoints to automate recognition and fetch card data. These endpoints use standard JSON and require an API key in the header for all requests.
Full documentation: https://api.flaree.app/swagger
Send a Flaree
POST /companies/webhook/flaree
Send a Flaree Card from one team member to another. This endpoint is ideal for triggering recognition events from within your internal tools or automation flows.
Required fields:
1. receiverEmail — recipient’s email address
2. giverEmail — sender’s email address
3. flareeId — ID of the Flaree card (found in card URL)
4. points — number of points to assign
Response: { success: true } if delivered successfully.
Get Flaree Cards
GET /companies/webhook/flaree-cards
Fetches all available Flaree Cards configured by your organization. Each card includes its unique ID and display name.
Useful for dropdowns, dynamic workflows, or custom admin panels.
Validate API Key
GET /companies/validate/api-key
Checks if a given API key is active and returns associated company data. Useful for debugging or integrating authentication workflows.