How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
PeerTube

PeerTube Users API

Using some features of PeerTube require authentication, for which User provide different levels of permission as well as associated user information. Each user has a corresponding local Account for federation.

Documentation Provider Profile APIs.io OpenAPI GitHub

PeerTube Users API is one of 54 APIs that PeerTube publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and rate-limit docs.

This API exposes 14 operations across 11 paths, and defines 20 schemas. It is described by OpenAPI 3.0.3, at version 8.1.0.

Requests are made against 3 base URLs: https://peertube2.cpy.re, https://peertube3.cpy.re, https://peertube.cpy.re.

14 operations 11 paths 20 schemas 1 DELETE2 GET10 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
8.1.0
Base URL
https://{instance}/api/v1
Authentication
OAuth 2.0
Contact
PeerTube Community
License
AGPLv3.0
Resource Areas
1

Authentication & Security 1

PeerTube Users API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the password flow, exposing 3 scopes.

  • OAuth2 — Authenticating via OAuth requires the following steps: - Have an activated account - [Generate] an access token for that account at /api/v1/users/token. - Make…

Paths & Operations 14

Across 11 paths, the API surfaces 14 operations — 1 DELETE, 2 GET, 10 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 14

Using some features of PeerTube require authentication, for which User provide different levels of permission as well as associated user information. Each user has a corresponding…

POST
/api/v1/users
Create a user
addUser body → 200403
GET
/api/v1/users
List users
getUsers 6 params → 200
DELETE
/api/v1/users/{id}
Delete a user
delUser 1 param → 204
GET
/api/v1/users/{id}
Get a user
getUser 2 params → 200
PUT
/api/v1/users/{id}
Update a user
putUser 1 param body → 204
POST
/api/v1/users/{id}/block
Block a user
1 param body → 204400403404
POST
/api/v1/users/{id}/unblock
Unblock a user
1 param → 204400403404
POST
/api/v1/users/ask-send-verify-email
Resend user verification link
resendEmailToVerifyUser body → 204
POST
/api/v1/users/{id}/verify-email
Verify a user
verifyUser 1 param body → 204403404
POST
/api/v1/users/ask-reset-password
Ask to reset password
body → 204
POST
/api/v1/users/{id}/reset-password
Reset password
1 param body → 204403404
POST
/api/v1/users/{id}/two-factor/request
Request two factor auth
requestTwoFactor 1 param body → 200403404
POST
/api/v1/users/{id}/two-factor/confirm-request
Confirm two factor auth
confirmTwoFactorRequest 1 param body → 204403404
POST
/api/v1/users/{id}/two-factor/disable
Disable two factor auth
disableTwoFactor 1 param body → 204403404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are User (35 properties), UserNotificationSettings (18 properties), Actor (10 properties), UpdateUser (8 properties). Each schema is shown below with its type and property counts.

NotificationSettingValue
integer
Notification type. One of the following values, or a sum of multiple values: - 0 NONE - 1 WEB - 2 EMAIL
usernameChannel
string
immutable name of the channel, used to interact with its actor
UserAdminFlags
integer
Admin flags for the user (None = 0, Bypass video blocklist = 1)
Actor
object
10 properties
User
object
35 properties
UserWithStats
AddUserResponse
object
1 property
UserRole
integer
The user role (Admin = 0, Moderator = 1, User = 2)
id
integer
UserNotificationSettings
object
18 properties
username
string
immutable name of the user, used to find or mention its actor
ActorImage
object
6 properties
VideoChannel
UpdateUser
object
8 properties
AddUser
object
8 properties 4 required
password
string
NSFWPolicy
string
NSFWFlag
integer
NSFW flags (can be combined using bitwise or operator) - 0 NONE - 1 VIOLENT - 2 EXPLICITSEX
RequestTwoFactorResponse
object
1 property
Account

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

peertube-users-api-openapi.yml Raw ↑

Other APIs PeerTube publishes across the network.

PeerTube Abuses API
AE Profile APIs.io
PeerTube Account Blocklist API
AE Profile APIs.io
PeerTube Accounts API
AE Profile APIs.io
PeerTube Automatic Tags API
AE Profile APIs.io
PeerTube Channels Sync API
AE Profile APIs.io
PeerTube Client Config API
AE Profile APIs.io
PeerTube Config API
AE Profile APIs.io
PeerTube Contact API
AE Profile APIs.io
PeerTube Debug API
AE Profile APIs.io
PeerTube Homepage API
AE Profile APIs.io
PeerTube Instance Follows API
AE Profile APIs.io
PeerTube Instance Redundancy API
AE Profile APIs.io
#User
← Back to P APIs
API Details
ID
peertube:peertube-users-api
Base URL
https://{instance}/api/v1
Docs
https://docs.joinpeertube.org/api/rest-getting-started
Provider
PeerTube
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=peertube-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/peertube-users-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of PeerTube Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.