Skip to main content
The EngageFabric API is a RESTful API that allows you to integrate gamification features into your applications. All API endpoints are versioned and follow consistent patterns.

Base URL

Authentication

All API requests require authentication via API key:
See Authentication for detailed information.

Request Format

Headers

Request Body

All request bodies should be JSON:

Response Format

Success Response

Error Response


HTTP Status Codes


Pagination

List endpoints support pagination:
Response:

Filtering & Sorting

Many endpoints support filtering and sorting:

Idempotency

For POST requests, use the X-Idempotency-Key header to ensure idempotent operations:
Idempotency keys are valid for 24 hours. Requests with the same key within this window will return the same response.

API Endpoints

Players

Manage player profiles, XP, levels, and currencies

Events

Track player actions and trigger gamification rules

Quests

Create and manage quest progress

Adventures

Seasonal content and quest collections

Leaderboards

Real-time rankings and competitions

Lobbies

Multiplayer lobby management

Chat

Real-time messaging

Rules

Configure gamification logic

SDKs

We provide official SDKs for easier integration:

OpenAPI Specification

Download the complete OpenAPI specification:

OpenAPI Spec

Download the OpenAPI 3.0 specification for code generation and API exploration