Open API
      Back to home
      1. Knowledge Base
      2. Open API

      Open API

      Duel provides an open API that can be used to retrieve programme data and assets or send e-commerce order updates.

      Members
      Events
      Orders 
      Assets 

      See our developer documentation at: https://developers.duel.tech/open-api/

      Duel provides an open API that can be used to retrieve programme data and assets or send e-commerce order updates.

      All API requests require basic authentication. You can create API user credentials in the Duel Dashboard under Settings > API Users

      Members

      Brand partners can use the API to retrieve detailed information about their members, including lists of all members or data for a specific individual. This data can then be utilised to customise and enhance communications, such as displaying personalised data on their e-commerce. 

      Member sync is included in Duel's CRM integrations 

      Events 

      The API also allows access to events within a brand's Duel program, like completed tasks or member advancements. This feature enables the triggering of communications from external sources, such as email or text, to further enhance engagement with members.

      Events sync is included in Duel's CRM integrations 

      Orders 

      Brand partners can use the API to input orders into the Duel dashboard, facilitating order tracking through our script and server setup. This functionality empowers brands to incentivize advocates for successful referrals and monitor the utilization of rewards efficiently.

      Orders sync is included in Duel's CRM integrations 

      Assets 

      Brand partners can retrieve all their assets from the Duel platform, enabling efficient repurposing of User-Generated Content (UGC) giving them the ability to create custom galleries on their ecom. 

      New API Endpoint: /api/v1/assets
      • Attributes Returned:
        • file_url: The original file URL, or large version if original is unavailable.
        • file_type: MIME type of the asset (e.g., "image/jpeg").
        • date: DateTime when the asset was uploaded or created.
        • source: Origin of the asset (ugc or operator).
        • task_id: Associated task identifier, if applicable.
        • member_id: Identifier of the member who uploaded the asset, or empty if uploaded by an operator.
        • product_skus: List of associated product SKUs.
        • social_post_domain: Platform from which the UGC was sourced (e.g., "Instagram").
        • social_post_url: URL to the original social post.

      How to Use the Assets API Endpoint

      1. Authentication: Ensure you have valid API credentials with Duel.
      2. GET Request:
        • URL: /api/v1/assets
        • Method: GET
        • Headers:
          • Authorization: Bearer <your_access_token>

      Response Format:
      The response will contain a JSON array of asset information as described above.