PeerTube · Example Payload

Get_Api_V1_Video Channels_Channelhandle_Ownership

List all ownership change requests for a specific channel. The authenticated user must be able to manage the channel.

Ownership Change

Get_Api_V1_Video Channels_Channelhandle_Ownership is an example object payload from PeerTube, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses

Example Payload

Raw ↑ 
{
  "operationId": "get_api_v1_video-channels_channelHandle_ownership",
  "method": "GET",
  "path": "/api/v1/video-channels/{channelHandle}/ownership",
  "summary": "List ownership change requests for a channel",
  "description": "List all ownership change requests for a specific channel. The authenticated user must be able to manage the channel.",
  "tags": [
    "Ownership Change"
  ],
  "parameters": [
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    },
    {
      "name": "state",
      "in": "query",
      "required": false,
      "description": "Filter by ownership change state",
      "schema": {
        "$ref": "#/components/schemas/ChangeOwnershipState"
      }
    },
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    },
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    },
    {
      "name": "sort",
      "in": "query",
      "required": false,
      "description": "",
      "schema": {
        "type": "string",
        "enum": [
          "-createdAt",
          "createdAt"
        ]
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "successful operation",
      "examples": {}
    },
    "400": {
      "description": "invalid parameters",
      "examples": {}
    },
    "403": {
      "description": "cannot manage the channel",
      "examples": {}
    },
    "404": {
      "description": "channel not found",
      "examples": {}
    }
  }
}