Skip to content

Sherpai Partner API

Welcome to the Sherpai Partner API documentation. This API provides access to social media analytics and dashboard data for partner integrations.

Overview

The Sherpai Partner API is a comprehensive RESTful API that provides access to social media analytics data, user profiles, and dashboard metrics across 9 major social media platforms. All API endpoints require authentication except for health checks and login.

Base URL: https://partner-api.sherp.ai Authentication: JWT tokens via Bearer authentication Supported Platforms: Facebook, Instagram, TikTok, YouTube, LinkedIn, Threads, Snapchat, Dailymotion, Pinterest

🚀 Quick Start

Get up and running in 4 steps:

curl -X POST https://partner-api.sherp.ai/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "api_client_key": "your-client-key",
    "api_secret_key": "your-secret-key"
  }'

curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  https://partner-api.sherp.ai/me

This returns your user profile with associated brands. Extract the brand_id from the brands array in the response.

curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  "https://partner-api.sherp.ai/analytics/?brand_id=<your_brand_id>&limit=10"

curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  "https://partner-api.sherp.ai/posts/?limit=10"

Get posts from all platforms, or filter by platform:

curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  "https://partner-api.sherp.ai/posts/?platform=facebook,instagram,tiktok&limit=10"

See full Quickstart guide →

Before You Start

Prerequisites

Before making your first API call, ensure you have:

  • ✅ Sherpai Partner Account: Contact your partner representative to get access
  • ✅ API Credentials: API client key and secret key (provided by your partner)
  • ✅ Configured Brand: At least one brand with connected social media accounts (Facebook, Instagram, TikTok, etc.)
  • ✅ Test Environment: A test brand with connected accounts for trying endpoints safely
  • ✅ Base URL: https://partner-api.sherp.ai

Complete prerequisites checklist →

Quick Start

Get started with the Sherpai Partner API in minutes:

  1. Get API Access - Set up authentication and get your API credentials
  2. Make Your First Request - Learn how to authenticate and make API calls
  3. Explore the API - Browse all available endpoints and try them out

  • Analytics & Insights

    Access comprehensive analytics data across all platforms, track performance metrics, and gain insights into your brand's social media presence.

    View Analytics API

  • Multi-Platform Posts

    Access unified post data from Facebook, Instagram, TikTok, YouTube, LinkedIn, Threads, and Snapchat in a single API call.

    View Posts API

Developer Resources

API Reference

  • Authentication - Learn about API authentication
  • Analytics - Access analytics and metrics
  • Posts - Unified posts API for all platforms
  • Users - Get user brand associations

Guides

Support

Need help? Contact us at tech@loopsider.com

Ready to get started? Begin with our getting started guide or jump into the API reference.