PeerTube · Example Payload

Get_Api_V1_Users_Me_Notifications

My Notifications

Get_Api_V1_Users_Me_Notifications 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_users_me_notifications",
  "method": "GET",
  "path": "/api/v1/users/me/notifications",
  "summary": "List my notifications",
  "description": "",
  "tags": [
    "My Notifications"
  ],
  "parameters": [
    {
      "name": "typeOneOf",
      "in": "query",
      "required": false,
      "description": "only list notifications of these types",
      "schema": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/NotificationType"
        }
      }
    },
    {
      "name": "unread",
      "in": "query",
      "required": false,
      "description": "only list unread notifications",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    },
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    },
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "successful operation",
      "examples": {}
    }
  }
}