SocialHub.AI
Book a demo
Resources · Developers

REST API Reference

48 endpoints across 11 resources. The SocialHub v2 REST API lets you manage stores, loyalty members, points, coupons, captures, the Ambassador program and tracking. All endpoints require Authorization: Bearer fl_live_… unless noted.

Base URLhttps://flash.socialhub.ai/api/v2
OpenAPI JSONRun from Claude (SoCode)

This reference mirrors the live API.It's a static snapshot of the endpoint catalog, grouped by resource. For the always-current, machine-readable contract (parameters, request bodies, response schemas), see the OpenAPI JSON →

Authentication

Authenticate with a Bearer key

Every request authenticates with a SocialHub API key (fl_live_…) sent as a Bearer token. Keys are scoped to your team and per-tool — create and manage them in your SocialHub account.

curl https://flash.socialhub.ai/api/v2/members \
  -H "Authorization: Bearer fl_live_your_key_here"

Prefer to keep the plaintext key out of your shell history? Export it as FLASH_API_KEY and reference the env var.

Manage API Keys
Reference

Endpoints

48 endpoints across 11 resource groups. Method, path and a one-line summary for each — the full parameter and schema detail lives in the OpenAPI JSON.

Stores

4 endpoints

Store management

GET/api/v2/stores
GET/api/v2/stores/{id}
POST/api/v2/stores
PUT/api/v2/stores/{id}

Members

11 endpoints

Loyalty member management

GET/api/v2/members
POST/api/v2/members
POST/api/v2/members/batch
GET/api/v2/members/{id}
PATCH/api/v2/members/{id}
GET/api/v2/members/{id}/points
POST/api/v2/members/{id}/points
GET/api/v2/members/{id}/tier
GET/api/v2/members/{id}/coupons
GET/api/v2/members/{id}/receipts
POST/api/v2/members/{id}/redeem-coupon

Orders

4 endpoints

Order ingestion → auto-award points, refunds, and reconciliation

GET/api/v2/orders
POST/api/v2/orders
POST/api/v2/orders/batch
POST/api/v2/orders/{externalOrderId}/refund

Catalog

5 endpoints

Product catalog (PIM) — products, variants, categories, brands; generic ERP/Shopify import

GET/api/v2/products
GET/api/v2/products/{id}
GET/api/v2/categories
GET/api/v2/brands
POST/api/v2/catalog/import

Member Tags

4 endpoints

Read and manually manage a member's tags

GET/api/v2/tags
GET/api/v2/members/{id}/tags
POST/api/v2/members/{id}/tags
DELETE/api/v2/members/{id}/tags/{tagKey}

Captures

1 endpoint

Capture records

GET/api/v2/captures

Coupons

4 endpoints

Coupon pools, codes, and redemption

GET/api/v2/coupons
GET/api/v2/coupons/pools
POST/api/v2/coupons/issue
POST/api/v2/coupons/{id}/redeem

Ambassador

3 endpoints

Ambassador program — candidates, ROI report, and affiliate codes

GET/api/v2/ambassador/candidates
GET/api/v2/ambassador/metrics
POST/api/v2/ambassador/members/{id}/issue-code

Tracking

2 endpoints

Page-visit / behavior analytics and event ingestion

GET/api/v2/tracking/stats
POST/api/v2/tracking/events

API Keys

3 endpoints

API key management

GET/api/v2/api-keys
POST/api/v2/api-keys
DELETE/api/v2/api-keys/{id}

Auth

7 endpoints

Authentication and user profile

POST/api/v2/auth/register
POST/api/v2/auth/login
GET/api/v2/auth/profile
PATCH/api/v2/auth/profile
POST/api/v2/auth/change-password
POST/api/v2/auth/forgot-password
POST/api/v2/auth/reset-password
OpenAPI JSON (machine-readable)Run from Claude (SoCode)Manage API KeysBack to Resources