Skip to main content
The mobile package uses standard HTTP headers for device detection, versioning, and synchronization.

Request Headers

Headers sent by mobile clients:

Response Headers

Headers sent by the server:

Header Details

X-Device-ID

A unique identifier for the device. Should persist across app reinstalls if possible. iOS:
Android:

X-App-Version

Semantic version of the client application.

X-Platform

Operating system identifier. Used for platform detection when User-Agent parsing is disabled. Valid values:
  • ios
  • android
  • windows
  • macos
  • web

X-API-Version

API version requested by the client. Supports formats:
  • v2
  • v2.1
  • 2
  • 2.1

X-Sync-Token

Opaque token for delta synchronization. Clients store and send back on subsequent sync requests.

X-API-Deprecated

Response header indicating the requested API version is deprecated. Clients should plan to upgrade.

X-Min-App-Version

Response header indicating the minimum required app version. Clients below this version should prompt for update.

Client Implementation

iOS (Swift)

Android (Kotlin)

Flutter (Dart)

Next Steps

Device Detection

How headers are parsed

API Reference

Complete API documentation