Platform APIs are a set of ready-made APIs provided by Sprintfy that cover the most common backend needs such as user management, media handling, reference data, notifications, and dynamic forms.

These APIs are available by default for every project and are designed to be consumed directly by web or mobile applications.

Important: Every API request must include the spfhash header. Each API has its own unique hash, which can be found in the API documentation inside the CMS.

User APIs allow authenticated users to manage their profile, security, connected accounts, and registered devices.

• Retrieve Authenticated User
  Returns the current user's profile information using the access token.
• Update User Information
  Update profile fields with support for meta data and lookup slugs.
• Update Password
  Allows the authenticated user to change their password securely.
• Update FCM Token
  Register or update the Firebase token used for push notifications.
• Remove FCM Token
  Remove a Firebase token when notifications are disabled or before logout.
• Register User Device
  Register a user device for tracking, notifications, or device-limit enforcement.
• Remove User Device
  Remove a registered device from the user account.
• Link Social Media Account
  Attach a social media account to the authenticated user for future login.
• Unlink Social Media Account
  Detach a linked social media account from the user profile.

Media APIs allow you to upload and manage files without adding file fields to your database tables.

• Upload Media Files
  Upload files and attach them to any model record dynamically. You must provide:
  • key – defined in Media Collections (CMS)
  • model_id – record ID or slug
  • files – uploaded files
• Delete Media Files
  Soft-delete media files using the media uuid.

Categories APIs provide hierarchical category management.

• List Categories
  Returns all categories or child categories when parent_slug is provided. To return only top-level categories, pass parent_id = 0.
• Retrieve Category
  Retrieve a single category using its slug.

• List Active Currencies
  Returns all active currencies available in the system.
• Retrieve Currency
  Retrieve currency details using its slug.

• List Active Languages
  Returns all active languages supported by the system.
• Retrieve Language
  Retrieve a language using its slug.

• List Pages
  Returns pages optionally filtered by parent or lookup slug. Use parent_id = 0 to return only top-level pages.
• Retrieve Page
  Retrieve page details using its slug.

• List Places
  Returns all places or children of a parent when parent_slug is provided.
• Retrieve Place
  Retrieve a place using its slug.
• Top-Level Places
  Returns only main (top-level) places.
• Child Places
  Returns children places using parent slug or ID.

Lookups APIs return reference data defined in the CMS.

• Retrieve Lookup Values
  Returns all lookup values under a given lookup key.

• List Notifications
  Returns all notifications belonging to the authenticated user.
• Mark Notifications as Read
  Marks all user notifications as read.

Dynamic Forms APIs allow frontend applications to render and submit forms defined in the CMS.

• Retrieve Form Definition
  Returns form structure and fields using the form spfy_id.
• Submit Form
  Submit form values using the form spfy_id and key-value pairs.
• Retrieve User Submission
  Returns the authenticated user's submission. Supports flat = true for flat object responses.
• Update Form Submission
  Update an existing submission using the submission spfy_id. Only changed values are required.