Jump to Content
Home
Guides
API Reference
Changelog
Discussions
Log In
API Reference
Log In
Home
Guides
API Reference
Changelog
Discussions
About tenants
All
Pages
Start typing to search…
JUMP TO
quickstart
Welcome to the FanHero API!
Authentication methods
Pagination
Geofencing
Tenant Endpoints
About tenants
Email
Send an email
post
About email templates
List email templates
get
Create an email template
post
Retrieve an email template
get
Update an email template
patch
Delete an email template
del
Organizations
About organizations
Does organization exist?
get
Get metadata
get
Generate API key
get
Revoke API key
post
User Management Endpoints
About accounts
Accounts
Account object
Account Status object
List accounts
get
Create an account
post
Retrieve an account
get
Update an account
patch
Delete an account
del
Forget account
post
Forgotten password
post
Update password
post
Create Social Sign-in
post
My Account
Retrieve my account
get
Update my account
patch
Account Status
Activate an account
patch
Deactivate an account
patch
Permanently ban an account
patch
Lift an account ban
patch
Temporarily ban an account
patch
Lift a temporary ban
patch
Account Sessions
About account sessions
Lis account sessions
get
Create an account session
post
Retrieve an account session
get
Update an account session
patch
Delete an account session
del
Account GDPR LGPD
List GDPR LGPD
get
Create GDPR LGPD
post
Retrieve GDPR LGPD
get
Update GDPR LGPD
patch
Delete GDPR LGPD
del
Roles
About roles
List roles
get
Create a role
post
Retreive a role
get
Update a role
patch
Delete a role
del
Permissions
About permissions
List permissions
get
Create a permission
post
Retrieve a permission
get
Update the permission
patch
Delete the permission
del
Subjects
About subjects
List subjects
get
Create a subject
post
Retrieve a subject
get
Update a subject
patch
Delete a subject
del
Profiles
About profiles
List profiles
get
Retrieve an account profile
get
Update account profile
patch
Delete account profile
del
Update my profile
patch
Custom Fields
About custom fields
List custom fields
get
Create a custom field
post
Retrieve a custom field
get
Update a custom field
patch
Delete a custom field
del
Authentication
Authenticate a user
post
Refresh a token
post
Sign out
post
Authorize OAuth 2.0
get
Headless CMS Endpoints
Channels
About channels
List channels
get
Create a channel
post
Retrieve a channel
get
Update a channel
patch
Delete a channel
del
Does channel exist?
get
Get metadata
get
Menus
List menus
get
Create a menu
post
Retrieve a menu
get
Update a menu
patch
Delete a menu
del
Billboards
Billboard object
List billboards
get
Create a billboard
post
Retrieve a billboard
get
Update a billboard
patch
Delete a billboard
del
Live Events
About live events
List live events
get
Create a live event
post
Retrieve a live event
get
Update a live event
patch
Delete a live event
del
Create media from a live event
post
Get live event metadata
get
Posts
List posts
get
Retrieve a post
get
Delete a post
del
Add audio
post
Add photo
post
Add text post
post
Add video
post
Update audio post
patch
Update photo post
patch
Update text post
patch
Update video post
patch
Continue watching
get
Pinned Posts
What is a pinned post?
List pinned posts
get
Create a pinned post
post
Get pinned post count
get
Retrieve a pinned post
get
Update a pinned post
patch
Delete a pinned post
del
Unpin a post
patch
Categories
Category object
List categories
get
Create a category
post
Retrieve a category
get
Update a category
patch
Delete a category
del
Pinned Categories
What is a pinned category?
List pinned categories
get
Create a pinned category
post
Retrieve a pinned category
get
Update a pinned category
patch
Delete a pinned category
del
Get pinned category count
get
Unpin a category
patch
Tags
Tag object
List tags
get
Create a tag
post
Retrieve a tag
get
Update a tag
patch
Delete a tag
del
Reactions
Add reaction
post
Delete a reaction
del
Comments
List comments
get
Create a comment
post
Retrieve a comment
get
Update a comment
patch
Delete a comment
del
Comment Votes
Add a comment vote
post
Playlists
Playlist object
List playlists
get
Create a playlist
post
Retrieve a playlist
get
Update a playlist
patch
Delete a playlist
del
Report
Report object
Create a report
post
Media
Media object
Lists media
get
Create media
post
Add video
post
Add photo
post
Add audio
post
Retrieve media
get
Delete media
del
Update audio media
patch
Update photo media
patch
Update video media
patch
Get media status
get
Uploads
Upload object
List uploads
get
Create an upload
post
Retrieve an upload
get
Update an upload
patch
Delete an upload
del
Customer Billing Endpoints
About products
Products
Add a product
post
Delete a product
del
Update a product
put
Product Prices
List product prices
get
Add a product price
post
Get a product price
get
Update a product price
patch
Delete a product price
del
Orders
List customer orders
get
Create a customer order
post
Create a purchase order
post
Create an override order
post
Retrieve a customer order
get
Update a customer order
patch
Delete a customer order
del
Video Analytics Endpoints
Video
Video view count
get
Unique view count
get
Total views per month
get
List views for thirty days
get
Total watch time
get
Total monthly watch time
get
Total watch time for thirty days
get
Statistics overview
get
List video descriptors
get
Views
Get view details
get
List views by video ID
get
List views by channel ID
get
Channels
Get total view count by channel ID
get
Get unique view count by channel ID
get
Get monthly view count by channel ID
get
Get daily views for thirty days
get
Get total watch time by channel ID
get
Get monthly watch time by channel ID
get
Get channel watch time for thirty days
get
List top ten viewed videos for a channel
get
List top ten watched videos for a channel
get
List top ten viewers by channel ID
get
List top ten watchers by channel ID
get
List top ten cities by channel ID
get
Categories
Get total view count by category ID
get
Get unique view count by category ID
get
Get monthly view count by category ID
get
List views for thirty days by category ID
get
Get total watch time by category ID
get
Total monthly watch time by category ID
get
Get daily watch time for thirty days
get
Accounts
Total number of registered accounts
get
Number of registered accounts by month
get
Number of registered accounts by day
get
Orders
Get valid oreder total for organization
get
Valid oreder totals by month
get
Valid oreder totals by product
get
Posts
Post totals
get
Total number of videos by channel ID
get
List last five videos by channel ID
get
Live Events
Live event total by channel ID
get
Powered by
About tenants
Ask AI
