Invites
List invites
- Get started
- GETFetch analytics
- GETFetch audit logs
- GETList categories
- POSTCreate category
- GETFetch category
- DELDelete category
- PATCHUpdate category
- GETList folders
- POSTCreate folder
- GETFetch folder
- DELDelete folder
- PATCHUpdate folder
- GETGet videos in folder
- POSTAdd video to folder
- DELRemove video from folder
- GETList identity providers
- POSTCreate identity provider
- GETFetch identity provider
- DELDelete identity provider
- PATCHUpdate identity provider
- POSTCreate transcribe
- GETList videos
- POSTCreate video
- GETFetch video
- DELDelete video
- PATCHUpdate video
- POSTCreate track
- DELDelete track
- POSTReplace thumbnail
- POSTCreate card
- DELDelete card
- PATCHUpdate card
- POSTCreate gate
- DELDelete gate
- PATCHUpdate gate
- POSTCreate hotspot
- DELDelete hotspot
- PATCHUpdate hotspot
- POSTCreate chapter
- DELDelete chapter
- PATCHUpdate chapter
Video API
Analytics
Audit logs
Categories
Folders
Identity providers
Transcribes
Videos
Invites
List invites
Fetch all invites
GET
/
invites
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
limit
integer
limit
integer
The maximum number of results to return
Add Example Value
cursor
string
cursor
string
A cursor to fetch the next page of results
Add Example Value
curl --request GET \
--url https://api.vidbeo.com/v2/invites \
--header 'Authorization: Bearer <token>'
{
"success": true,
"result": [],
"links": {
"next": "https://api.vidbeo.com/v2/invites?limit=10&cursor=AbCdEfGhIJkLMnOpQrStUvWxYz"
},
"errors": []
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
limit
integer
default: 25The maximum number of results to return
cursor
string
A cursor to fetch the next page of results
Response
200 - application/json
success
boolean
requiredresult
object[]
requiredresult.id
string
requiredresult.email
string
requiredresult.authentication
enum<string>
requiredAvailable options:
password
, sso
result.role
enum<string>
requiredAvailable options:
viewer
, uploader
, admin
, owner
result.created_by
string
requiredresult.created_time
string
requiredresult.updated_by
string
requiredresult.updated_time
string
requiredlinks
object
requirederrors
object[]
requiredcurl --request GET \
--url https://api.vidbeo.com/v2/invites \
--header 'Authorization: Bearer <token>'
{
"success": true,
"result": [],
"links": {
"next": "https://api.vidbeo.com/v2/invites?limit=10&cursor=AbCdEfGhIJkLMnOpQrStUvWxYz"
},
"errors": []
}