API Documentation

This GraphQL-powered API provides access to feature flags, push notifications, username management, and app metadata.

Queries

  • featureFlags: Returns a list of all feature flags.
  • featureFlag(key: String!): Returns the status of a specific feature flag.
  • docs: Returns the API instructions (this document).
  • version: Returns the APP version in semver format.
  • changeLog: Returns the APP change log.
  • validateUsername(username: String!): Validates username format and generates fingerprint.
  • checkUsernameAvailability(username: String!): Checks if a username is available.

Mutations

  • updateFeatureFlag(key: String!, value: Boolean!): Updates the status of a feature flag.
  • sendNotification(title: String!, body: String!, icon: String, data: String): Broadcasts a push notification to all connected clients via WebSocket.
  • sendNotificationToSocket(socketId: String!, title: String!, body: String!, icon: String, data: String): Sends a push notification to a specific socket/user via WebSocket.
  • sendLocalizedNotification(notificationId: String!, params: String): Broadcasts a localized notification (all languages) to all clients. Supports ICU params.
  • sendLocalizedNotificationToSocket(socketId: String!, notificationId: String!, params: String): Sends a localized notification to a specific socket.
  • createUsername(userId: String!, username: String!): Creates a new username for a user.

Authentication

This API uses [insert authentication mechanism here].


  • Ko-fi Logo