Skip to main content
Documentation Powered by Redocly

OpenAPI definition (v0)

Download OpenAPI specification:Download

Search Filter Service

Handles all Patreon Shout search filter related tasks for the database.

Gets all of the user's filters from the database

query Parameters
loginToken
required
string

Responses

Adds a user filter to the database

Request Body schema: application/json
loginToken
required
string
filter
required
string
filter_name
required
string

Responses

Request samples

Content type
application/json
{
  • "loginToken": "string",
  • "filter": "string",
  • "filter_name": "string"
}

Deletes one of the user's filters from the database

Request Body schema: application/json
loginToken
required
string
filter_id
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "loginToken": "string",
  • "filter_id": 0
}

Receiver Service

Handles all Webhook related functions.

Receives post information from Patreon after a post is either published, updated, or deleted

path Parameters
webaccountId
required
integer <int64>
header Parameters
x-patreon-signature
required
string
x-patreon-event
required
string
User-Agent
required
string
Request Body schema: application/json
object (PatreonDataV2)
object (PatreonLinksV2)

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "links": {
    }
}

Receives information from Twitter after OAuth

query Parameters
code
string
state
string

Responses

Receives information from Patreon after OAuth

query Parameters
code
string
state
string

Responses

Tag Service

Handles all Patreon Shout post tag related tasks for the database.

Gets the tags that a user has for a specific post

query Parameters
required
object (TagGetRequest)

Responses

Adds a new tag to the user's tag for a specific post

Request Body schema: application/json
tag
required
string
login_token
required
string
url
required
string

Responses

Request samples

Content type
application/json
{
  • "tag": "string",
  • "login_token": "string",
  • "url": "string"
}

Deletes a tag that a user has for a specific post

Request Body schema: application/json
tag
required
string
login_token
required
string
url
required
string

Responses

Request samples

Content type
application/json
{
  • "tag": "string",
  • "login_token": "string",
  • "url": "string"
}

List Service

Handles all Patreon Shout list related tasks for the database.

Gets the Lists of the user that the provided post is apart of

query Parameters
loginToken
required
string
url
required
string

Responses

Updates the lists of the specified post in the json request

Request Body schema: application/json
url
required
string
login_token
required
string
required
Array of objects (ListUpdate)

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "login_token": "string",
  • "list_updates": [
    ]
}

Gets the posts from a user's list

query Parameters
loginToken
required
string
list_id
required
integer <int32>

Responses

Updates one of the user's lists

Request Body schema: application/json
loginToken
required
string
title
required
string
description
required
string
list_id
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "loginToken": "string",
  • "title": "string",
  • "description": "string",
  • "list_id": 0
}

Adds a new list to the user's lists

Request Body schema: application/json
loginToken
required
string
title
required
string
description
required
string

Responses

Request samples

Content type
application/json
{
  • "loginToken": "string",
  • "title": "string",
  • "description": "string"
}

Deletes one of the user's lists

Request Body schema: application/json
list_id
required
integer <int32>
loginToken
required
string

Responses

Request samples

Content type
application/json
{
  • "list_id": 0,
  • "loginToken": "string"
}

Adds a post to the user's favorites list

Request Body schema: application/json
login_token
required
string
url
required
string

Responses

Request samples

Content type
application/json
{
  • "login_token": "string",
  • "url": "string"
}

Adds a post to the user's favorites list

Request Body schema: application/json
login_token
required
string
url
required
string

Responses

Request samples

Content type
application/json
{
  • "login_token": "string",
  • "url": "string"
}

Gets the Lists of the user via login token

query Parameters
loginToken
required
string

Responses

Post Service

Handles all Patreon post related tasks for the database.

Gets the saved Patreon posts of a specified creator

query Parameters
required
object (PostGetMultipleRequest)

Responses

Gets the saved Patreon posts of a specified creator

query Parameters
campaign
required
integer <int32>

Responses

Web Account Service

Handles all Web Account related tasks for the database.

Registers WebAccounts during PatreonShout sign up

query Parameters
login_token
required
string

Responses

Registers WebAccounts during PatreonShout sign up

Request Body schema: application/json
login_token
string
integration_name
string
Enum: "DISCORD" "TWITTER" "INSTAGRAM"
data
string

Responses

Request samples

Content type
application/json
{
  • "login_token": "string",
  • "integration_name": "DISCORD",
  • "data": "string"
}

Retrieves Patreon access and refresh tokens for a WebAccount containing the given login token

Request Body schema: application/json
login_token
required
string
current_password
required
string
new_password
required
string

Responses

Request samples

Content type
application/json
{
  • "login_token": "string",
  • "current_password": "string",
  • "new_password": "string"
}

Webhook

query Parameters
login_token
required
string

Responses

Registers WebAccounts during PatreonShout sign up

Request Body schema: application/json
user
required
string
pass
required
string

Responses

Request samples

Content type
application/json
{
  • "user": "string",
  • "pass": "string"
}

Retrieves a login token given valid WebAccount details

Request Body schema: application/json
userName
required
string
userPassword
required
string

Responses

Request samples

Content type
application/json
{
  • "userName": "string",
  • "userPassword": "string"
}

Retrieves Patreon access and refresh tokens for a WebAccount containing the given login token

query Parameters
login_token
required
string

Responses

Deletes a login token from a WebAccount if it exists

query Parameters
login_token
required
string

Responses