Watched Words

List account watched words

GET

https://peertube2.cpy.re/api/v1/watched-words/accounts/{accountName}/lists

PeerTube >= 6.2

curl -X GET 'https://peertube2.cpy.re/api/v1/watched-words/accounts/string/lists' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/watched-words/accounts/string/lists', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/watched-words/accounts/string/lists',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "id": 42,
      "listName": "string",
      "words": [
        "string"
      ],
      "subscriptionUrl": "https://example.com",
      "updatedAt": "2021-05-04T08:01:01.502Z",
      "createdAt": "2021-05-04T08:01:01.502Z"
    }
  ]
}

Parameters

accountNamestringrequiredpath

account name to list watched words

Response

200OKany

successful operation

Response fields application/json

totalinteger

Example

dataArray<WatchedWordsLists>

Show child attributes

idid>= 1

Example

listNamestring

wordsArray<string>

subscriptionUrlstring<url> | null

updatedAtstring<date-time>

Example

2021-05-04T08:01:01.502Z

createdAtstring<date-time>

Example

2021-05-04T08:01:01.502Z

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Docs by Sourcey