# Influencer Hero API API documentation for the Influencer Hero platform. Version: 1.4.2 ## Servers ``` https://api.influencer-hero.com ``` ## Security ### ApiKeyAuth Your Influencer Hero API key. You can find your API key at [https://app.influencer-hero.com/api](https://app.influencer-hero.com/api). Include this header in all authenticated requests. Type: apiKey In: header Name: X-API-KEY ## Download OpenAPI description [Influencer Hero API](https://docs.influencer-hero.com/_bundle/ih_api.yaml) ## Test endpoints Endpoints to test authenticated and public requests ### Public Hello Endpoint - [GET /v1/public/hello](https://docs.influencer-hero.com/ih_api/test-endpoints/publichello.md): A public endpoint to verify the API is working without authentication. Use /v1/account/hello to test authenticated requests. ### Authenticated Hello Endpoint - [GET /v1/account/hello](https://docs.influencer-hero.com/ih_api/test-endpoints/accounthello.md): An authenticated endpoint to verify user credentials. ## Search & Reports ### Get Search - [POST /v1/search/get_search](https://docs.influencer-hero.com/ih_api/search-and-reports/getsearch.md): Endpoint for the influencer finder. Each request provides 10 influencers, costing 1 search credits for every new influencer seen. ### Get Analytics Report - [GET /v1/search/get_analytics_page](https://docs.influencer-hero.com/ih_api/search-and-reports/getanalyticspage.md): Retrieves an analytics report for a specific influencer. If a report doesn't exist yet, one will be generated using your account's report credits. Credit Usage: - If the influencer's report has been previously generated, no credits are used. - If a new report is needed, 1 report credit is deducted from your account. ## Identify influencers ### Identify Influencers by Email (async) - [POST /v1/search/identify_influencers](https://docs.influencer-hero.com/ih_api/identify-influencers/identifyinfluencers.md): Identifies influencers based on email addresses. This can be used e.g. to identify influencers from your customer lists. This endpoint is asynchronous and will return a success message immediately. The influencers will be processed in the background and will appear in the "Your customers" tab of the influencer finder after a few minutes. ### Identify Influencer by Email (real-time) - [GET /v1/search/identify_influencers_real_time](https://docs.influencer-hero.com/ih_api/identify-influencers/identifyinfluencersrealtime.md): Identifies a single influencer based on their email address in real-time. Unlike the async endpoint, this returns the influencer data immediately if a match is found. Please use the async endpoint for high-throughput use cases or when possible. ## Helper endpoints ### Handle Search - [GET /v1/search/database_influencers](https://docs.influencer-hero.com/ih_api/helper-endpoints/databaseinfluencers.md): Retrieves influencer handles or topic-tags for use in relevance, audience_relevance, and search filters. ### Location Search - [GET /v1/search/locations](https://docs.influencer-hero.com/ih_api/helper-endpoints/searchlocations.md): Retrieves location IDs and names for use in geo and audience_geo filters. ## Import influencers ### Create CRM Deal - [POST /v1/crm/create_deal](https://docs.influencer-hero.com/ih_api/import-influencers/createdeal.md): Creates a new influencer deal page in the specified campaign board/dealflow. The difference between this and the "Submit Influencers to campaign" endpoint is that this directly adds the influencer to the CRM, bypassing the outreach step. This is useful for manually adding influencers that you already work with or have a relationship with. This is like manually adding an influencer via the CSV import feature. ### Submit Influencers to campaign - [POST /v1/search/submit_influencers](https://docs.influencer-hero.com/ih_api/import-influencers/submitinfluencers.md): This endpoint adds the influencers to the specified campaign. The influencer is scheduled for outreach if the campaign is set to send one. This is like adding influencers to a campaign from the Influencer Finder. Credit Usage: - Each influencer added costs 0.04 search credits. - Duplicate influencers (already in the account) are automatically skipped. ## Influencer Page ### Get Deal Information - [GET /v1/crm/get_deal_details](https://docs.influencer-hero.com/ih_api/influencer-page/getdealdetails.md): Retrieves information about a specific deal in the CRM. ### Create Note - [POST /v1/crm/create_note](https://docs.influencer-hero.com/ih_api/influencer-page/createnote.md): Creates a new note on a deal. ### Create Task - [POST /v1/crm/create_task](https://docs.influencer-hero.com/ih_api/influencer-page/createtask.md): Creates a new task on a deal. ### Update Deal Stage - [POST /v1/crm/update_dealstage](https://docs.influencer-hero.com/ih_api/influencer-page/updatedealstage.md): Updates the funnel stage or the dealflow of a deal ### Update Deal Info - [POST /v1/crm/update_deal_info](https://docs.influencer-hero.com/ih_api/influencer-page/updatedealinfo.md): Updates the contact and profile information for an influencer deal. Use status_update_only: true to only update the active status without modifying other fields. ### Enable UGC Capture - [POST /v1/crm/update_post_capture](https://docs.influencer-hero.com/ih_api/influencer-page/updatepostcapture.md): Enables or disables UGC (User Generated Content) capture for an influencer collaboration. When enabled, the system will automatically capture posts from the influencer's social media profiles. You can listen for UGC posts via webhooks or periodically retrieve the UGC posts from the API. Tracked UGC posts will also be available in the content library of your account. ## Affiliate Tracking [Advanced] Server-side endpoints for tracking affiliate actions and performance. For most use cases, the [client-side tracking script](https://docs.influencer-hero.com/tracking_script) will be sufficient. ### New Influencer Click - [POST /v1/crm/new_influencer_click](https://docs.influencer-hero.com/ih_api/affiliate-tracking/increaseinfluencerclicks.md): Increases the number of tracked clicks on an influencer's deal page. ### New Influencer Referral - [POST /v1/crm/new_influencer_referral](https://docs.influencer-hero.com/ih_api/affiliate-tracking/newinfluencerreferral.md): Adds a new order/referral to an influencer's affiliate performance. ## Account Search ### Dealflow Search - [GET /v1/account/search_dealflows](https://docs.influencer-hero.com/ih_api/account-search/searchdealflows.md): Retrieves all dealflows in the user's account. ### Brand Search - [GET /v1/account/search_brands](https://docs.influencer-hero.com/ih_api/account-search/searchbrands.md): Searches for brands in the platform account. ### Deal Search - [GET /v1/crm/autocomplete](https://docs.influencer-hero.com/ih_api/account-search/crmautocomplete.md): Searches for influencers in your CRM by name or handle. Returns matching deals that can be used for navigation or further operations. ## Managing Webhooks ### Create Webhook - [POST /v1/account/create_webhook](https://docs.influencer-hero.com/ih_api/managing-webhooks/createwebhook.md): Creates a webhook for various triggers. ### Get Webhooks - [GET /v1/account/get_webhooks](https://docs.influencer-hero.com/ih_api/managing-webhooks/getwebhooks.md): Returns all webhooks configured for your account. ### Delete Webhook - [DELETE /v1/account/delete_webhook](https://docs.influencer-hero.com/ih_api/managing-webhooks/deletewebhook.md): Deletes an existing webhook. ## Webhooks Receive real-time notifications when events occur in your account. Webhooks are secured via HMAC-SHA256 signatures. ### New payout request - [POST new_payout_request](https://docs.influencer-hero.com/ih_api/webhooks/newpayoutrequest.md): This webhook is fired whenever a user creates a payout request in Influencer Hero. The request body contains all the details of the requested payout as well as minimal information about the associated deal. Security / Verification - Each request includes a timestamp (X-InfluencerHero-Timestamp) and an HMAC-SHA256 signature (X-InfluencerHero-Signature) in the headers. - The payload can be used along with the secret key your system has stored (provided by Influencer Hero) to verify authenticity of the request. ### New Max Bid Requested - [POST new_max_bid](https://docs.influencer-hero.com/ih_api/webhooks/newmaxbid.md): This webhook is triggered when a new Max Bid is requested for a deal. The receiving endpoint can use X-InfluencerHero-Timestamp and X-InfluencerHero-Signature to verify authenticity via HMAC-SHA256. ### Update Discount Code - [POST update_discount_code](https://docs.influencer-hero.com/ih_api/webhooks/updatediscountcode.md): This webhook is triggered when a discount code is updated for a collaboration. The receiving endpoint can use X-InfluencerHero-Timestamp and X-InfluencerHero-Signature to verify authenticity via HMAC-SHA256. ### Update Custom Link - [POST update_custom_link](https://docs.influencer-hero.com/ih_api/webhooks/updatecustomlink.md): This webhook is triggered when a custom link is updated (or deleted) for a collaboration. The receiving endpoint can use X-InfluencerHero-Timestamp and X-InfluencerHero-Signature to verify authenticity via HMAC-SHA256. ### Update Commission - [POST update_commission](https://docs.influencer-hero.com/ih_api/webhooks/updatecommission.md): This webhook is triggered when a commission percentage is updated for a collaboration. The receiving endpoint can use X-InfluencerHero-Timestamp and X-InfluencerHero-Signature to verify authenticity via HMAC-SHA256. ### Product Sent - [POST product_sent](https://docs.influencer-hero.com/ih_api/webhooks/productsent.md): This webhook is fired whenever a user sends a product to an influencer or contact. The request body contains core details of the shipped order (in a simplified form), along with minimal information about the related deal. Security / Verification - Each request includes a timestamp (X-InfluencerHero-Timestamp) and an HMAC-SHA256 signature (X-InfluencerHero-Signature) in the headers. - The payload can be used along with the secret key your system has stored (provided by Influencer Hero) to verify authenticity of the request. ### New Email Sent - [POST new_email_sent](https://docs.influencer-hero.com/ih_api/webhooks/newemailsent.md): This webhook is triggered when a new email is sent to a deal contact. The receiving endpoint can use X-InfluencerHero-Timestamp and X-InfluencerHero-Signature to verify authenticity via HMAC-SHA256. ### New Influencer Post - [POST new_influencer_post](https://docs.influencer-hero.com/ih_api/webhooks/newinfluencerpost.md): This webhook is triggered when an influencer publishes a new post on social media that is linked to a deal. The receiving endpoint can use X-InfluencerHero-Timestamp and X-InfluencerHero-Signature to verify authenticity via HMAC-SHA256. ### New Influencer Reply - [POST new_influencer_reply](https://docs.influencer-hero.com/ih_api/webhooks/newinfluencerreply.md): This webhook is triggered when an influencer replies to an email associated with a particular deal. The receiving endpoint can use X-InfluencerHero-Timestamp and X-InfluencerHero-Signature to verify authenticity via HMAC-SHA256. ### New Influencer Order - [POST new_influencer_order](https://docs.influencer-hero.com/ih_api/webhooks/newinfluencerorder.md): This webhook is triggered when a new order is attributed to an influencer (via discount code or affiliate link). The receiving endpoint can use X-InfluencerHero-Timestamp and X-InfluencerHero-Signature to verify authenticity via HMAC-SHA256.