Home

Table of Contents

INTRO
api
- v2
  - activation/email
  - administration
  - auth
  - cdn
  - connect
  - comment
  - creator
  - creatorplanfeaturelevel
  - discord
  - edges
  - faq/list
  - get
  - image
  - live
  - moderation
  - moderator
  - payment
  - plan
  - push/web
  - socket
  - support
  - sync
  - user
  - video
- v3
  - content
  - creator
  - images
  - plan
  - user
ACP
- v2
  - dashboard
CMS
- v3
  - processing
  - transcode

INTRO

This page needs better formatting… If you have any ideas, feel free to open an issue.

Most api calls follow the following format:

https://floatplane.com/api/v3/creator/list

/api/{version}/{api-call}

api

v2

activation/email

email

confirm

?code={code}&username={user}

request

?email={email}

administration

moderators

add

?user={userID}

get

/:user

global

add

?user={userID}

list

N/A

remove

?user={userID}

auth

?username={user}&password={pass}

logout

?username={user}&password={pass}&email={email}

spoof

begin

?targetUserId={userId}

end

checkFor2faLogin

?token={token}

cdn

delivery

connect

:site

?site={site}&login={login}&create={create}&redirect={redirect}&token={token}&app={app}

:site/callback

?site={site}

list

Lists connected accounts, like LTT forum and Discord

complete

?username={user}&password={pass}&email={email}&connection={conn}&signupLinkCode={code}

refresh

dissociate

comment

moderate

{creatorGUID: creatorGUID, comment: comment, banType: type, videoGUID: videoGUID, reason: reason}

creator

agreement

{creatorGUID: id}

confirm

?creatorGUID={id}&agreement={?}

administration

moderators/add

?creator={creatorGUID}&user={userId}

named

?creatorURL={creatorUrlName}

info

?creatorGUID={creatorGUID}

creatorplanfeaturelevel

list

n/a

cost

?features={features}

discord

bot

callback

?redirect={url}&creator={creatorGUID}

info

?link={?}&creator={creatorGUID}

invite/generate

?link={?}&creator={creatorGUID}

link

?redirect={url}&creator={creatorGUID}

list

?creator={creatorGUID}

unlink

?link={?}&creator={creatorGUID}

update

?link={?}&creator={creatorGUID}&releaseChannel={?}&inviteLink={link}&roles={roles}

edges

n/a

faq/list

FAQ info

get

player

:guid

{guid: guid}

image

optimizations

{imageType: type}

live

config

update

?liveGUID={liveGUID}&config={?}

thumbnail

upload

?liveGUID={liveGUID}&mode={?}

moderation

user

ban

?user={userID}&type={banType}&duration={time}&comment={reason}

list

?user={userID?}

comment

hide

?commentGUID={commentGUID}&videoGUID={videoGUID}

unhide

?commentGUID={commentGUID}&videoGUID={videoGUID}

unban

?ban={banID?}&comment={unbanReason}

moderator

user

info

?user={userGUID}

unban

?user={userID}&creatorGUID={creatorGUID}&comment={comment}&banType={type}

userBanStatus

?user={userID}&creatorGUID={creatorGUID}&banType={type}

payment

address

add

?addressData={addressData}

delete

?address={address}

list

Lists addresses

set

?address={address}

update

?addressData={addressData}&address={address}

braintree

token

invoice

list

Lists past subscription history

method

add

?processor={?}&token={token}&address={address}

delete

?method={method}

list

List payment methods

set

?method={method}

subscription

cancel

?subscription={sub}

purchase

?plan={plan}

tax

estimate

?plan={plan}

webhook

:paymentProcessor

:subPay

{paymentProcessor: paymentProcessor}

plan

feature

list

?plan={plan}&creator={creatorGUID}

info

Creator plan info

list

?creator={creatorGUID}

publish

?creator={creatorGUID}&id={planID}

update

?creator={creatorGUID}&add={?}&delete={?}&edit={?}

push/web

info

Push notification info

register

Uh… No clue, tbh

socket

user

N/A

:id

id

support

{name: n, email: e, topic: type, message: msg, subject: sbj}

ticket/types

[
  "Question",
  "Incident",
  "Problem",
  "Feature Request",
  "Account"
]

sync

connect

POST

disconnect

POST

user

activity

?id={id}

administrator

?id={id}

avatar

Uploads avatar

ban

status

?creator={creatorGUID}

Checks whether use is banned by creator?

creator

?id={id}

email

update

?id={id}&email={email}

complete

?code={code}&username={user}&password={pass}

info

?id={userId}

User’s info, avatar, etc.

links

?id={id}

GET

?links={links}

POST something?

named

?username={user}

Get user info by name

notificationsetting

POST request

?creator={creatorGUID}&property={property}&newValue={?}

GET request

password

change

?currentPassword={pass}&newPassword={newPass}

reset

?key={key}&password={newPass}

request

?email={email}

validate

?key={key}

security

{
  "twofactorEnabled": true,
  "twofactorBackupCodeEnabled": false
}

2fa

Generates 2fa secret

activate

?token={token}

deactivate

Deactivates 2fa

backupcode

Generates backup code

activate

Activates backup code

deactivate

Deactivates backup code

self

n/a

subscribed

n/a, from doesUserHaveSub

subscriptions

?active={bool}

Returns list of creators that user is subscribed to.

update

?id={userGUID}

POST user object?

video

transcode

progress

?video={videoGUID}

unsubscribe

?video={videoGUID}

url

?guid={videoGUID}&quality={1080}

v3

content

creator

?id={creatorGUID}&fetchAfter{#}&search={search}

Creator’s content, with ability to search and fetch older videos