Neynar · Example Payload

Fetch Channel Notifications For User

Returns a list of notifications for a user in specific channels

Notifications

Fetch Channel Notifications For User is an example object payload from Neynar, 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": "fetch-channel-notifications-for-user",
  "method": "GET",
  "path": "/v2/farcaster/notifications/channel/",
  "summary": "For user by channel",
  "description": "Returns a list of notifications for a user in specific channels",
  "tags": [
    "Notifications"
  ],
  "parameters": [
    {
      "name": "",
      "in": "",
      "required": false,
      "description": ""
    },
    {
      "name": "fid",
      "in": "query",
      "required": true,
      "description": "FID of the user you you want to fetch notifications for. The response will respect this user's mutes and blocks.",
      "schema": {
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "name": "channel_ids",
      "in": "query",
      "required": true,
      "description": "Comma separated channel_ids (find list of all channels here - https://docs.neynar.com/reference/list-all-channels)",
      "schema": {
        "example": "neynar,farcaster",
        "type": "string",
        "x-comma-separated": true
      }
    },
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "Number of results to fetch",
      "schema": {
        "default": 15,
        "example": 15,
        "format": "int32",
        "maximum": 25,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "description": "Pagination cursor.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "Success",
      "schema": {
        "$ref": "#/components/schemas/NotificationsResponse"
      },
      "example": null
    },
    "400": {
      "description": "Bad Request",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    }
  }
}