Operations

Each operation has a dedicated Swagger-style page with parameters, request body schema, and response documentation.

Method Path Summary Tags Reference
GET /tools Get available API tools Meta View operation
GET /reports List JSON reports backed by materialized views Reports View operation
GET /reports/{id} Fetch a report as JSON Reports View operation
GET /users Search users in your accessible scope Users View operation
POST /users Create a user in your account scope Users View operation
GET /publishers List publishers in the caller's scope Publishers View operation
POST /publishers Create a publisher Publishers View operation
GET /agencies List agencies Agencies View operation
GET /agencies/{id} Get a single agency Agencies View operation
GET /advertisers Search and lookup advertisers or affiliate programs Advertisers View operation
GET /advertisers/{id} Get advertiser details Advertisers View operation
GET /transactions Search transactions with AI-friendly filters Transactions View operation
GET /deals Search deals with AI-friendly filters Deals View operation
GET /advertisers/{id}/similar_advertisers List similar advertisers Advertisers View operation
GET /advertisers/{id}/related_advertisers List related advertisers Advertisers View operation
POST /advertisers/{id}/find_more_contacts Enqueue Dex AI contact discovery Advertisers View operation
GET /opportunities List advertiser opportunities Advertisers View operation
GET /contacts Search contacts in the caller's scope Contacts View operation
POST /contacts Create a contact Contacts View operation
POST /contacts/add Add a contact Contacts View operation
GET /advertisers/{id}/contacts List advertiser contacts Advertisers View operation
GET /domains/search Search advertisers by domain Domains View operation
GET /schema Fetch the full OpenAPI 3.0 schema Meta View operation
GET /verticals List verticals Verticals View operation
GET /clicks List click events Clicks View operation
GET /advertisers/search_by_domain Advertiser lookup by hostname Advertisers View operation
GET /deals/{id} Get a single deal Deals View operation
POST /deals/{id}/translate Copy-edit / translate a deal Deals View operation
GET /transactions/{id} Get a single transaction Transactions View operation
GET /publishers/{id} Get a single publisher Publishers View operation
PATCH /publishers/{id} Update a publisher Publishers View operation
POST /publishers/{id}/find_linkedin_users Kick off LinkedIn-backed team discovery for a publisher Publishers View operation
POST /publishers/{publisher_id}/account_admins Promote a user to publisher account admin Publishers View operation
DELETE /publishers/{publisher_id}/account_admins/{user_id} Demote a publisher account admin Publishers View operation
GET /networks List affiliate networks Networks View operation
GET /networks/{id} Get a single network Networks View operation
GET /status_changes List advertiser status change events Status Changes View operation
GET /tags List tags used in the catalog Tags View operation
GET /tags/{id}/advertisers List advertisers tagged with the given tag Tags View operation
GET /users/{id} Fetch a user Users View operation
PATCH /users/{id} Update a user Users View operation
POST /users/{id}/resend_invitation Resend an invitation email Users View operation
POST /users/{id}/rotate_api_key Rotate a user's API key Users View operation
POST /deeplinks/generate Generate an affiliate deeplink Deeplinks View operation
GET /extension/config Fetch the browser extension config Extension View operation
GET /search Universal Searchkick-backed omnibox search Search View operation
GET /exports List the caller's recent generative export reports Reports View operation
POST /exports Kick off a generative export report Reports View operation
GET /exports/{id} Fetch a single export report's status and download URL Reports View operation

API Playground

Same try-it experience as the main docs: run discovery GETs against your API key, or open each URL in a new tab. Sign in to enable live testing with your API key.

Action Method Endpoint Description
MCP bootstrap (GET) GET /mcp Live MCP health + setup JSON for the authenticated key.
List API tools GET /api/v1/tools Machine-readable tool index (mirrors OpenAPI listTools).
Fetch schema GET /api/v1/schema OpenAPI-style schema payload.
List reports catalog GET /api/v1/reports Major and raw report IDs for your scope.
Sample deals GET /api/v1/deals?limit=3 Quick JSON check that the API responds.
Universal search GET /api/v1/search Cross-type discovery in one request.
GET /mcp MCP

GET /mcp — verify MCP transport and read integration URLs from JSON.

Open 

    

  




            

            

              

  

    

      

        

          POST /mcp — tools/list
            MCP
        

          
JSON-RPC tools/list — same tool catalog OpenAPI describes operation-by-operation.

      

      

        
          Open
        
      

    


    

        

      

      

    

  




            

            

              

  

    

      

        

          GET /api/v1/tools
            v1
        

          
Tool definitions for agents.

      

      

        
          Open
        
      

    


    

        

      

      

    

  




            

            

              

  

    

      

        

          GET /api/v1/schema
            v1
        

          
API schema document.

      

      

        
          Open
        
      

    


    

        

      

      

    

  




            

            

              

  

    

      

        

          GET /api/v1/reports
            v1
        

          
Report catalog.

      

      

        
          Open
        
      

    


    

        

      

      

    

  




            

            

              

  

    

      

        

          GET /api/v1/deals?limit=3
            v1
        

          
Sample deals response.

      

      

        
          Open
        
      

    


    

        

      

      

    

  




            

            

              

  

    

      

        

          GET /api/v1/search?q=brand&types=advertisers,deals&per_type_limit=3
            v1
        

          
Universal search with explicit type filters — useful after generating a client from this OpenAPI index.

      

      

        
          Open
        
      

    


    

        

      

      

    

  




            

          

        

      

    


    

      

        

          
Servers

          

            

              
                

                  URL
                  Description
                

              
              
                  

                    https://app.hienergy.ai/api/v1
                    Production server
                  

                  

                    http://localhost:3000/api/v1
                    Development server
                  

              
            

          

        

      

    


    

      

        

          
Security Schemes

          

            

              
                

                  Scheme
                  Type
                  In
                  Name
                  Description
                

              
              
                  

                    ApiKeyAuth
                    apiKey
                    header
                    X-Api-Key
                    Preferred authentication method for AI agents, MCP clients, and server-to-server integrations
                  

                  

                    OAuthBearer
                    http
                    
                    
                    Auth0 OAuth bearer token authentication for signed-in user clients that already manage OAuth tokens
                  

              
            

          

        

      

    


    

  

  

    
Ask Dex AIIntegration help

    

      

        
If this page feels TLDR, ask Dex AI.

          

            Dex AI speaks your language, and all the other languages you may not. It will write the integration for you with the right endpoint and headers in one plain-English answer.
          


        

            

                JavaScript
                Python
                TypeScript
                React
                Java
                C#
                Go
                PHP
                Ruby
                Swift
                Kotlin
                Webflow
            


          Open MCP docs
        

      


      

        
    
            
  • 
              
              Use named MCP tools instead of stitching raw API calls together
            
    • 
            
  • 
              
              Read the docs index, OpenAPI schema, and integration guide first
            
    • 
            
  • 
              
              Get code in the language your app already uses
            
    •