API docs by Redocly

YouTubeSync (1.0.0)

Download OpenAPI specification:Download

Channel

Get Saved Destination Channels

query Parameters
page
integer
Example: page=1

The page parameter specifies the page number of results to retrieve. Use this parameter to navigate through multiple pages of saved channels when the dataset is large.
per_page
integer
Example: per_page=1

The per_page parameter specifies the number of results to display per page. Use this parameter to control the number of items returned in a single response.
header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

GetChannelsFromDB

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "channels": [
    ],
  • "backup_statistics": {
    },
  • "channel_statistics": {
    }
}

Authentication

Generate Auth Url

query Parameters
redirect_uri
string
Example: redirect_uri=https://localwhmcs.com/platform/100

The redirect_uri parameter specifies the URL where users will be redirected after successfully authenticating. Use this parameter to define the callback location that will handle the authorization code or access token response.

Examples:

"https://example.com/auth/callback" - Specifies a typical callback URL for handling authentication responses.

"https://localhost:3000/oauth/callback" - Specifies a local development environment URL for testing authentication flows.
header Parameters
X-API-Key
string
Example: {{X-API-Key}}

(Required)

Accept
string
Example: application/json

Responses

Handle Call Back

query Parameters
code
string
Example: code=4/0AanRRrswCUrs3KL67UvSdaKBjuvts8YNeWj3vb5fGtKBQ6GEsu2HlCxhMsHshuX7XlWeeg

The code parameter specifies the temporary authorization code issued after a successful user authentication. Use this parameter to exchange the code for an access token, enabling API calls on behalf of the user.

Examples:

"4/0ARtbsJvz..." - A valid authorization code issued after the user grants permission.

"8/0AXzQCB...o" - Another valid example representing a unique authorization code for a different session or user.
redirect_uri
string
Example: redirect_uri=https://localwhmcs.com/platform/100

The redirect_uri parameter specifies the URL where users will be redirected after successfully authenticating. Use this parameter to define the callback location that will handle the authorization code or access token response.

Examples:

"https://example.com/auth/callback" - Specifies a typical callback URL for handling authentication responses.

"https://localhost:3000/oauth/callback" - Specifies a local development environment URL for testing authentication flows.
header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Content-Type
string
Example: multipart/form-data
Accept
string
Example: application/json
Request Body schema: multipart/form-data
code
string

The code parameter specifies the temporary authorization code issued after a successful user authentication. Use this parameter to exchange the code for an access token, enabling API calls on behalf of the user.

Examples:

"4/0ARtbsJvz..." - A valid authorization code issued after the user grants permission.

"8/0AXzQCB...o" - Another valid example representing a unique authorization code for a different session or user.
redirect_uri
string

The redirect_uri parameter specifies the URL where users will be redirected after successfully authenticating. Use this parameter to define the callback location that will handle the authorization code or access token response.

Examples:

"https://example.com/auth/callback" - Specifies a typical callback URL for handling authentication responses.

"https://localhost:3000/oauth/callback" - Specifies a local development environment URL for testing authentication flows.

Responses

Response samples

Content type
application/json
{
  • "result": "success"
}

Videos

List Videos

path Parameters
channelId
required
integer
Example: 69

(Required)

query Parameters
page
integer
Example: page=1

The page parameter specifies the page number of results to retrieve. Use this parameter to navigate through multiple pages of results when the dataset is paginated.
per_page
integer
Example: per_page=2

The per_page parameter specifies the number of results to display per page. Use this parameter to control the number of items returned in a single response.
search
string

The search parameter specifies the keyword or phrase to search for in video titles, descriptions, or metadata. Use this parameter to filter the list of videos returned based on the query provided.

Examples:

"funny cat videos" - Searches for videos related to funny cat content.

"2025 tech conference" - Searches for videos related to a specific event or topic like a future tech conference.
tags
string
Example: tags=1,2,3

The tag parameter specifies a specific label or category assigned to videos. Use this parameter to filter videos based on their associated tags and narrow down the search to relevant content.

Examples:

tag: "comedy" - Filters and returns videos that are tagged with "comedy" content.

tag: "tutorial" - Filters and returns videos that are tagged with "tutorial" content, useful for instructional videos.
sort
string
Example: sort=date_added_newest

The sort parameter specifies how the list of videos should be ordered in the response. Use this parameter to define the sorting criteria, such as by date, views, or ratings, to customize the order in which videos appear.
header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Get Ongoing Video Downloads

path Parameters
channelId
required
integer
Example: 69

(Required)

query Parameters
page
integer
Example: page=1

The page parameter specifies the page number of results to retrieve. Use this parameter to navigate through multiple pages of results when the dataset is paginated.
per_page
integer
Example: per_page=2

The per_page parameter specifies the number of results to display per page. Use this parameter to control the number of items returned in a single response.
search
string

The search parameter specifies a query to filter ongoing video downloads based on keywords or partial video titles. Use this parameter to refine the list of active downloads that match the given search term.

Examples:

search: "tutorial" - Filters the ongoing video downloads to show those containing "tutorial" in their title.

search: "weekend" - Filters the ongoing video downloads to show those with "weekend" as part of their title, which may be more specific or narrow the results.
header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Get Completed Video Downloads

path Parameters
channelId
required
integer
Example: 69

(Required)

query Parameters
page
integer
Example: page=1

The page parameter specifies the page number of results to retrieve. Use this parameter to navigate through multiple pages of results when the dataset is paginated.
per_page
integer
Example: per_page=2

The per_page parameter specifies the number of results to display per page. Use this parameter to control the number of items returned in a single response.
search
string

The search parameter specifies the query term used to filter the completed video downloads. Use this parameter to search for downloads by specific keywords, titles, or user names.

Examples:

search: "tutorial" - Filters the completed video downloads to only those with the keyword "tutorial" in their title or metadata.

search: "user123" - Filters the completed video downloads to only those associated with the user "user123."
header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "videos": [
    ],
  • "pagination": {
    }
}

Get Video Transfer Progress

path Parameters
channelId
required
integer
Example: 69

(Required)

query Parameters
page
integer
Example: page=1

The page parameter specifies the page number of results to retrieve. Use this parameter to navigate through multiple pages of results when the dataset is paginated.
per_page
integer
Example: per_page=2

The per_page parameter specifies the number of results to display per page. Use this parameter to control the number of items returned in a single response.
header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Delete Video

path Parameters
channelId
required
integer
Example: 69

(Required)

videoId
required
integer
Example: 5

(Required)

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
X-Http-Method-Override
string
Example: <string>
Content-Type
string
Example: multipart/form-data
Accept
string
Example: application/json
Request Body schema: multipart/form-data
object

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Video deleted successfully"
}

List Captions

path Parameters
channelId
required
integer
Example: 69

(Required)

videoId
required
integer
Example: 5

(Required)

query Parameters
page
integer
Example: page=1

The page parameter specifies the page number of results to retrieve. Use this parameter to navigate through multiple pages of results when the dataset is paginated.
per_page
integer
Example: per_page=10

The per_page parameter specifies the number of results to display per page. Use this parameter to control the number of items returned in a single response.
search
string

The search parameter allows you to filter the captions returned by the API. Use this parameter to narrow down the captions to those that match the specified search term.

Examples:

search: "intro" - This value filters the captions to only include those with the word "intro" in the title or content.

search: "error" - This value filters the captions to include only those related to error messages or containing the term "error".
header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "captions": [
    ],
  • "pagination": {
    }
}

List comments

path Parameters
channelId
required
integer
Example: 70

(Required) youtube channel id
videoId
required
integer
Example: 5

(Required) video id
query Parameters
per_page
integer
Example: per_page=2

The page parameter specifies the page number of results to retrieve. Use this parameter to navigate through multiple pages of results when the dataset is paginated.
page
integer
Example: page=1

The per_page parameter specifies the number of results to display per page. Use this parameter to control the number of items returned in a single response.
search
string

The search parameter filters the list of comments based on a specified keyword or phrase. Use this parameter to narrow down the results to only those comments that contain the search term.

Examples:

search: "great product" - Filters the comments to display only those containing the phrase "great product."

search: "refund" - Filters the comments to display only those that mention the word "refund."
header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Statistics

Get Channel Statistics From DB

path Parameters
channelId
required
integer
Example: 70

(Required)

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "channel_statistics": {
    },
  • "backup_statistics": {
    }
}

Get Channel Statistics From Youtube Data in DB

path Parameters
channelId
required
integer
Example: 70

(Required)

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "statistics": {
    }
}

Get Channel Statistics From Youtube API

path Parameters
channelId
required
integer
Example: 70

(Required)

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "statistics": {
    }
}

Entry Summaries

Get Daily Entries

path Parameters
channelId
required
string
Example: <string>

(Required)

query Parameters
page
integer
Example: page=1

The page parameter specifies the page number of results to retrieve. Use this parameter to navigate through multiple pages of results when the dataset is paginated.
per_page
integer
Example: per_page=1

The per_page parameter specifies the number of results to display per page. Use this parameter to control the number of items returned in a single response.
date
string
Example: date=2024-12-24

The date parameter specifies the particular day for which daily entries are being requested. This parameter helps filter the entries to only those relevant to the specified date. Use this to fetch data specific to a single day.

Examples:

date: "2024-01-15" - Retrieves daily entries for January 15, 2024.

date: "2024-12-31" - Retrieves daily entries for December 31, 2024, representing the end of the year.
header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "entries": [
    ],
  • "total": 1,
  • "per_page": 1,
  • "current_page": 1,
  • "last_page": 1
}

Get Month Summary

path Parameters
channelId
required
integer
Example: 70

(Required)

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "summary": [
    ],
  • "total": 1,
  • "per_page": 10,
  • "current_page": 1,
  • "last_page": 1
}

Get Week Summary

path Parameters
channelId
required
integer
Example: 70

(Required)

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "entries": [
    ],
  • "total": 1,
  • "per_page": 10,
  • "current_page": 1,
  • "last_page": 1
}

Get Day Summary

path Parameters
channelId
required
string
Example: <string>

(Required)

query Parameters
start_date
string
Example: start_date=2024-12-10

The start_date parameter specifies the beginning date for the requested day's summary. It determines the timeframe from which the summary data will be calculated. Use this parameter to filter the data based on a specific starting date.

Examples:

start_date: "2024-12-10" - Requests the summary starting from December 10th, 2024, providing data from that day onward.
end_date
string
Example: end_date=2024-12-24

The end_date parameter specifies the end date for the requested day's summary. It defines the timeframe up to which the summary data will be considered. Use this parameter to filter data for a specific end date.

Examples:

end_date: "2024-12-24" - Requests the summary data up to December 24th, 2024, providing data until that date.
header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "entries": [
    ],
  • "total": 1,
  • "per_page": 10,
  • "current_page": 1,
  • "last_page": 1
}

Get Year Summary

path Parameters
channelId
required
integer
Example: 70

(Required)

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "entries": [
    ],
  • "total": 1,
  • "per_page": 10,
  • "current_page": 1,
  • "last_page": 1
}

Logs

Get Activity Logs

path Parameters
channelId
required
integer
Example: 70

(Required)

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "logs": [
    ],
  • "pagination": {}
}

Playlists

List Playlists

path Parameters
channelId
required
integer
Example: 70

(Required) youtube channel id
query Parameters
page
integer
Example: page=1

The page parameter specifies the page number of results to retrieve. Use this parameter to navigate through multiple pages of results when the dataset is paginated.
per_page
integer
Example: per_page=1

The per_page parameter specifies the number of results to display per page. Use this parameter to control the number of items returned in a single response.
search
string

The search parameter allows users to filter the list of playlists by a specific keyword or phrase. This helps narrow down the results to only those playlists that match the search query, improving the relevance of the returned data.

Examples:

search: "rock music" - Filters the playlists to include only those with the term "rock music" in their title or description.

search: "2024" - Filters the playlists to include only those that are tagged with or related to the year 2024.
header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Delete Playlist

path Parameters
channelId
required
integer
Example: 70

(Required)

playlistId
required
integer
Example: 7

(Required)

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Playlist deleted successfully"
}

List playlist items

path Parameters
channelId
required
integer
Example: 70

(Required)

playlistId
required
integer
Example: 7

(Required)

query Parameters
per_page
integer
Example: per_page=1

The per_page parameter specifies the number of results to display per page. Use this parameter to control the number of items returned in a single response.
page
integer
Example: page=1

The page parameter specifies the page number of results to retrieve. Use this parameter to navigate through multiple pages of results when the dataset is paginated.
header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Global Settings

Update Settings

path Parameters
channelId
required
integer
Example: 70

(Required)

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Content-Type
string
Example: multipart/form-data
Accept
string
Example: application/json
Request Body schema: multipart/form-data
synchronize_comments
integer

The synchronize_comments parameter controls whether the system should automatically synchronize comments across different platforms. Use this parameter to ensure that any changes made to comments are reflected in real time across all connected systems.

Examples:

synchronize_comments: 1 - This value enables the automatic synchronization of comments, ensuring that any new or updated comments are immediately reflected in all linked systems.

synchronize_comments: 0 - This value disables the synchronization, meaning that comments will not be updated across other platforms even if changes are made.

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Settings updated successfully"
}

Get Settings

path Parameters
channelId
required
integer
Example: 70

(Required)

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "settings": {
    }
}

Tags

Create Tag

path Parameters
channelId
required
integer
Example: 70

(Required)

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
tag_name
string
  • Represents the name or label assigned to a specific tag.
    • This property identifies the tag and can be used to categorize or label items.
    • Tag names are typically used for filtering, searching, or organizing content.

Responses

Request samples

Content type
application/json
{
  • "tag_name": "new tag"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "tag_id": 6,
  • "tag_name": "new tag"
}

Get Tags

path Parameters
channelId
required
integer
Example: 70

(Required)

query Parameters
page
integer
Example: page=1

The page parameter specifies the page number of results to retrieve. Use this parameter to navigate through multiple pages of results when the dataset is paginated.
per_page
integer
Example: per_page=1

The per_page parameter specifies the number of results to display per page. Use this parameter to control the number of items returned in a single response.
search
string

The search parameter is used to filter tags based on a keyword or phrase. This parameter influences the API request by narrowing down the returned tags to those that match the search term.

Examples:

search: "tech" - This would return tags that contain the word "tech" in their name.

search: "2023" - This would return tags that are related to the year 2023.

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Get All Tags

path Parameters
channelId
required
integer
Example: 70

(Required)

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "tags": [
    ]
}

Delete Tag

path Parameters
channelId
required
integer
Example: 70

(Required)

tagId
required
integer
Example: 5

(Required)

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
X-Http-Method-Override
string
Example: <string>
Content-Type
string
Example: application/x-www-form-urlencoded
Accept
string
Example: application/json
Request Body schema: application/x-www-form-urlencoded
tag_name
string

The tag_name parameter specifies the name of the tag to be deleted. Use this parameter to identify which tag should be removed from the system. The API will attempt to delete the tag with the exact name provided.

Examples:

tag_name: "new tag 2.1" - Deletes the tag named "new tag 2.1" from the system.
_METHOD
string

The _METHOD parameter is used to specify the HTTP method for the request. In some cases, this parameter is necessary to override the method for an endpoint, especially when an API requires a specific method for certain actions.

Examples:

_METHOD: "PUT" - Specifies that the request should use the PUT HTTP method, which may be used in cases where the API requires a method override for the Delete Tag operation.

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Tag updated successfully",
  • "tag_id": "6",
  • "tag_name": "new tag 2.1"
}

Subscriptions

List Subscriptions

path Parameters
channelId
required
integer
Example: 70

(Required)

query Parameters
page
integer
Example: page=1

The page parameter specifies the page number of results to retrieve. Use this parameter to navigate through multiple pages of results when the dataset is paginated.
per_page
integer
Example: per_page=1

The per_page parameter specifies the number of results to display per page. Use this parameter to control the number of items returned in a single response.
search
string

The search parameter allows users to filter subscriptions by a specific keyword or term. It helps narrow down the list of subscriptions returned by the API, ensuring only relevant results are included in the response.

Examples:

search: "premium" - Filters the subscription list to only include those with the word "premium" in their title or description.

search: "2025" - Filters subscriptions to include only those related to upcoming events or plans for the year 2025.
header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Transfers

Transfer Videos with Auth

path Parameters
channelId
required
integer
Example: 70

(Required)

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
authorization_code
string
  • The authorization code used for verifying and authorizing the request.
    • It is typically provided after a user grants permission during an OAuth authorization flow.
    • This code is required for obtaining an access token or making authorized requests on behalf of the user.
redirect_uri
string
source_channel_id
string
  • The unique identifier for the source YouTube channel.
    • This value links the request to a specific YouTube channel, often associated with the channel's data.
    • Example values: 'UC1kxLIoSs1Ciow4JpN_LG-w', 'UCabcdefg123456'.
video_ids
Array of strings
  • An array containing the unique IDs of the videos associated with the request.
    • Each item in the array represents a specific video and is used for identifying and working with those videos in the system.
    • Example values: ['WBL7ywZFLm4'], ['Xyz123abc456', 'A1B2C3D4E5'].

Responses

Request samples

Content type
application/json
{
  • "authorization_code": "4/0AcvDMrBAnrzSkvTu29m5aUTFnWBwHKUX-TCNNgGXLTwm8UlY1WR35xJTBj07Qcv8hjwT6Q",
  • "redirect_uri": "https://localwhmcs.com/platform/100",
  • "source_channel_id": "UC1kxLIoSs1Ciow4JpN_LG-w",
  • "video_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Transfer request successfully queued"
}

Transfer Subscriptions with Auth

header Parameters
X-API-Key
string
Example: {{X-API-Key}}
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
authorization_code
string
  • A unique code used for authorizing the request.
    • This code is typically generated during an authentication or authorization process.
    • Example values: '4/0AcvDMrBQjHn-uttkDaVw1CzbbfcY14M7eQa3ZVCv70f5vf2HjqowgyG7pHlhCg7qY1MTTw', '4/1AcvDMrBQjHn-abc123xyz'.
redirect_uri
string
source_channel_id
string
  • A unique identifier for the source channel.
    • This represents the source from where the subscription or request is originating.
    • Example values: 'UCgWqc_pK9erWBP1pUTDdiqw', 'UC2Lv5OsfGR6PmnfPv43dsfh'.
subscription_ids
Array of strings
  • A list of subscription identifiers associated with the request.
    • These IDs are used to specify which subscriptions the request applies to.
    • Example values: ['B_-zMfrK2fj4ueAanXhzqsyJ8QpkaHNOovslm4yOMuw'], ['A1234xg9hT5u123k6Aq7FYz'].

Responses

Request samples

Content type
application/json
{
  • "authorization_code": "4/0AcvDMrBQjHn-uttkDaVw1CzbbfcY14M7eQa3ZVCv70f5vf2HjqowgyG7pHlhCg7qY1MTTw",
  • "redirect_uri": "https://localwhmcs.com/platform/100",
  • "source_channel_id": "UCgWqc_pK9erWBP1pUTDdiqw",
  • "subscription_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Transfer request successfully queued"
}

Transfer Videos

path Parameters
channelId
required
string
Example: UC1kxLIoSs1Ciow4JpN_LG-w

(Required)

targetChannelId
required
string
Example: UCgWqc_pK9erWBP1pUTDdiqw

(Required)

header Parameters
X-API-Key
string
Example: {{X-API-Key}}

(Required)

Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
video_ids
Array of strings
  • A list of unique identifiers for videos.
    • These IDs represent specific videos and can be used to access or reference them.
    • Example values: ['ht63ZLByVG4'], ['WBL7ywZFLm4'], ['M9hj7kI8JZ8'].

Responses

Request samples

Content type
application/json
{
  • "video_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Transfer request successfully queued"
}