LogoLogo
  • 📣Welcome!
  • ☑️Quick Start
  • ✔️Terms, Definitions, Abbreviations & Regulations
    • Terms
    • Definitions
      • ✔️Entity
      • ✔️Entity Class
      • ✔️Memory Class
      • ✔️Authentication Key
    • Abbreviations
    • Regulations
  • 🚩Essentials
    • ✔️Entity Classes
      • ✔️Brand
      • ✔️User
        • ✔️Password
        • ✔️Username
        • ✔️Accounts
        • ✔️Referral
        • ✔️User Notification
        • ✔️Usage
      • ✔️Device
      • ✔️Plans & Pricing
        • ✔️License
          • ✔️Usage
        • ✔️Package
        • ✔️Feature
        • ✔️Configuration
        • ✔️Price
        • ✔️Coupon
      • ✔️Payment-Related
        • ✔️Payment
        • ✔️Payment History
        • ✔️Payment Method
        • ✔️Wallet
      • ✔️Point-Related
        • ✔️Point
        • ✔️Point Event
        • ✔️Point History
        • ✔️Point Reward
      • ✔️Role-Based Access Control (RBAC)
        • ✔️Role
        • ✔️Permission
      • ✔️Tracking-Related
        • ✔️Tracking event
        • ✔️Tracking activity
        • ✔️Tracking email
        • ✔️Email pattern
        • ✔️Helpdesk
      • ✔️System Configuration
        • ✔️SMTP Setting
        • ✔️Blacklist
        • ✔️Configuration
        • ✔️External authentication provider
        • ✔️Payment Provider
      • ✔️System Definition
        • ✔️Country
        • ✔️State
        • ✔️City
        • ✔️Currency
        • ✔️Language
        • ✔️Time Zone
    • ✔️Memory Classes
      • ✔️Event Class
      • ✔️Token Service Class
      • ✔️Error Manager
      • ✔️Session Manager
      • ✔️Version
      • ✔️Mail Service
      • ✔️CDN Service
    • ✅Third-party APIs
      • Webhooks
  • 🎯Guide
    • ✔️Login with Google
    • Integrate i18n
    • Integrate reCAPTCHA
  • References
    • Design Specifications
      • System Definitions
        • Country
        • State
        • City
        • Time Zone
        • Currency
        • Language
      • System Configurations
        • Configuration
        • External Login Provider
        • Payment Provider
        • BlackList
        • CDN
        • Address
      • Soft Deletion
        • Brand
          • Brand Email
          • Brand Link
          • Brand Profile
          • Brand Setting
        • User
          • User Profile
          • User Setting
        • Device
          • Device Profile
      • Role-Based Access Control
        • Role
        • Permission
      • Plans & Pricing
        • Feature
        • License
        • configuration
        • Package
        • Coupon
        • Price
      • Payment-Related
        • Payment
        • Payment Method
        • Payment History
        • Wallet
      • Point-Related
        • Point
        • Point Event
        • Point History
      • Tracking-Related
        • Tracking Activity
        • Tracking Event
        • Tracking Email
        • Tracking Email Pattern
        • Tracking Email Read
        • Helpdesk
        • Helpdesk Feedback
      • Relationships
        • Coupon - User
        • External Login Provider - User
        • Package - Feature
        • Role - Permission
    • ✔️JFW API
      • Overview
      • Authentication
      • Rate Limiting
      • Errors
      • API Reference
        • App Integrations
          • Get apps integration
          • Authentication
            • Creates an app integration authentication
            • Deletes an app integration authentication
            • Gets an app integration authentication
            • Get apps integration authentication with brand
            • Test building an authentication URL
            • Updates an app integration authentication
          • Payment Gateway
            • Create an app integration payment gateway
            • Delete an app integration payment gateway
            • Get an app integration payment gateway
            • Get apps integration payment gateway with brand
            • Test creating a checkout link
            • Update an app integration payment gateway
          • Push Notification
            • Create an app integration push notification
            • Delete an app integration push notification
            • Get an app integration push notification
            • Get an app integration push notification with brand
            • Update an app integration push notification
          • SMS
            • Create an app integration SMS
            • Delete an app integration SMS
            • Get an app integration SMS
            • Get apps integration SMS with brand
            • Test sending an SMS message
            • Update an app integration SMS
          • SMTP
            • Create an app integration SMTP
            • Delete an app integration SMTP
            • Get an app integration SMTP
            • Get apps integration SMTP with brand
            • Test sending an email message
            • Update an app integration SMTP
        • Brands
          • Check domain if exists
          • Create a brand
          • Create a link with a brand
          • Delete a link for a brand
          • Generate a new domain
          • Get a brand
          • Get a brand by url
          • Get brands
          • Get a link
          • Get links by type
          • Get links
          • Update a link
          • Update a brand
          • Get emails with a brand
          • Update a brand's profile
          • Update a brand's setting
          • Update a email
        • CDN
          • Delete a file CDN
          • Get a file CDN
          • Get files CDN
          • Upload a file CDN
        • Cities
        • Commission rate
          • Creates a commission rate
          • Deletes a commission rate
          • Gets a commission rate
          • Gets discount value
          • Get commission rates
          • Updates a commission rate
        • Configurations
          • Create a configuration
          • Delete a configuration
          • Get configurations
          • Get a configuration
          • Update a configuration
        • Constants
          • Brand Link
          • Black List
          • Coupon
          • Commission Rate
          • Device
          • Invoice
          • Issue
          • License
          • Organization
          • Payment
          • Transaction
          • Tracking Event
          • Tracking Notification
          • Feature
          • User
          • Wallet
          • Error
        • Coupons
          • Create a Coupon
          • Delete a Coupon
          • Get a Coupon
          • Get Coupons (*)
          • Update a Coupon
        • Cryptographies
          • Decrypt
          • Encrypt
        • Countries
        • Currencies
        • Devices
          • Checks user access device
          • Create a device
          • Delete a device
          • Get a device
          • Get current device of the user authorized
          • Get devices
          • Statistics
          • Update a device
        • Domains
          • Get domains
        • Events
          • Get email template default by event
          • Get an email template by event
          • Get events
          • Get events earning wallet
          • Get events that are associated with email templates
          • Get events that are associated with phone templates
          • Get phone template by event
          • Get phone template default by event
        • Exchange rates
          • Get exchange rates
          • Convert currency
        • Email Template
          • Create an email template
          • Delete an email template
          • Get an email template
          • Get email templates
          • Gets all placeholder keys available
          • Update an email template
        • Features
          • Create a feature
          • Delete a feature
          • Get a feature
          • Get features
          • Update a feature
        • Invoices
          • Delete an invoice
          • Get invoices
          • Get an invoice
          • Export an invoice
        • Issue categories
          • Create an issue category
          • Delete an issue category
          • Get issue categories
          • Get an issue category
          • Update an issue category
        • Issues
          • Create an issue
          • Create an issue reaction
          • Delete an issue
          • Delete an issue reaction
          • Get issues
          • Get an issue
          • Get issues by list id
          • Get children issues
          • Update an issue
        • Languages
        • Licenses
          • Applies a license to the logged user
          • Applies a license to the given login name
          • Applies a license to the given a user
          • Checks a license key
          • Create the licenses
          • Count licenses created
          • Delete a license
          • Get licenses
          • Get a license
          • Generate license key
          • Purchase to add licenses by checkout link
          • Purchase to add licenses by wallet
          • Statistics the percentage licenses used
        • MFA
          • Get a list of MFA
        • Organizations
          • Adds a new user to the organization
          • Adds a user for default language code organization system
          • Assign role for a user in an organization
          • Creates an organization
          • Deletes an organization
          • Get an organization
          • Get organizations
          • Get users of an organization
          • Remove a user in an organization
          • Updates an organization
          • Updates users status in an organization
        • Notifications
          • Delete a notification
          • Get notifications by the user authorized
          • Mark a notification as read
          • Push notification message for tokens
          • Push notification data message by the given device codes
          • Push notification data message by tokens
          • Push notification data message by devices
          • Updates all notification
          • Updates status notifications
          • Updates status of a notification
        • Packages
          • Add features to a package
          • Create a package
          • Delete a package
          • Get a package
          • Get packages
          • Get prices from a package
          • Update a package
          • Remove features from a package
        • Payments
          • Get a payment
          • Get payments
          • Gets the overview Sell Dashboar
        • Permissions
          • Add roles to a permission
          • Create a permission
          • Delete a permission
          • Get a permission
          • Get permissions
          • Update a permission
        • Prices
          • Create a price
          • Delete a price
          • Generate checkout link
          • Get a price
          • Get prices
          • Update a price
        • Resource types
          • Create a resource type
          • Delete a resource type
          • Get a resource type
          • Get resource types
          • Update a resource type
        • Roles
          • Assign users to a role
          • Delete a role
          • Create a role
          • Get a role
          • Get roles
          • Grants permissions to a role
          • Get permissions granted by role
          • Remove permissions from a role
          • Update a role
        • States
        • Subscription types
          • Create a subscription type
          • Delete a subscription type
          • Get a subscription type
          • Get subscription types
          • Update a subscription type
        • Time zones
        • Tracking Activities
          • Get activities (*)
          • Get a activity
        • Tracking emails
          • Get a tracking email
          • Get tracking emails
        • Users
          • Activate a user
          • Add a device to a user
          • Applies the referral code to a user
          • Assigns roles to a user
          • Authentication by Apple
          • Authentication by email OTP
          • Authentication by Google
          • Authentication by magic link
          • Authentication by SMS OTP
          • Authentication
          • Change password
          • Check referral user code
          • Configurations
          • Deactive a user
          • Delete a user
          • Email address verification
          • Forgot password
          • Get a user by username
          • Get a user
          • Get devices from a user
          • Get users
          • Gets the current user logged in
          • Gets the referees of a user
          • List all the brand partners authenticate
          • Lock a user
          • Register a new user
          • Remove a device from a user
          • Reset password
          • Revokes roles to a user
          • Statistics users
          • Suspend a user
          • Unlock a user
          • Unsuspend a user
          • Update a user
          • Update user type
          • Verify email address OTP to authentication
          • Verify SMS OTP to authentication
        • Wallets
          • Add money to a Wallet with checkout link
          • Apply redeem code
          • Create a wallet default
          • Convert wallet money
          • Close wallet
          • Get wallets
          • Get the wallet histories
      • Libraries
        • Javascript
        • Dot Net
        • Flutter
  • ☑️Change logs
  • ❔Questions & Feedback
  • References
Powered by GitBook
On this page
  • Activities
  • Accounts
  • Brands
  • CDN
  • Devices
  • Email templates
  • Events
  • External auth providers
  • Features
  • Helpdesks
  • Languages
  • Licenses
  • Mails
  • Notifications
  • Packages
  • Permissions
  • Points
  • Prices
  • Roles
  • States
  • Subscription types
  • Time zones
  • Users
  • Wallets
  • Webhooks

Was this helpful?

  1. References
  2. JFW API

API Reference

PreviousErrorsNextApp Integrations

Last updated 1 day ago

Was this helpful?

The following versions apply to all API endpoints: JFW API version: 4.2.30.2

Dive into the specifics of each API endpoint by checking out our complete documentation.

Activities

Everything related to tracking activities:

Accounts

Everything related to accounts:

Brands

Everything related to brands:

CDN

Everything related to CDN:

Devices

Everything related to devices:

Email templates

Everything related to email templates:

Events

Everything related to tracking events:

External auth providers

Everything related to external authentication providers:

Features

Everything related to features:

Helpdesks

Everything related to helpdesks:

Languages

Everything related to languages:

Licenses

Everything related to licenses:

Mails

Everything related to mail services:

Notifications

Everything related to notifications:

Packages

Everything related to packages:

Permissions

Everything related to permissions:

Points

Everything related to points:

Prices

Everything related to prices:

Roles

Everything related to roles:

States

Everything related to states:

Subscription types

Everything related to subscription types:

Time zones

Everything related to time zones:

Users

Everything related to users:

Wallets

Everything related to wallets:

Webhooks

Everything related to webhooks:

✔️
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/activities/README.md
Accounts
Brands
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/cdn.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md
https://github.com/1Byte-Software/jfw-developers-gitbook-docs/blob/main/references/api-reference/endpoints/broken-reference/README.md