Neynar · Example Payload

Fetch Notification Tokens

Returns a list of notifications tokens related to a mini app

Frame

Fetch Notification Tokens 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-notification-tokens",
  "method": "GET",
  "path": "/v2/farcaster/frame/notification_tokens/",
  "summary": "List of mini app notification tokens",
  "description": "Returns a list of notifications tokens related to a mini app",
  "tags": [
    "Frame"
  ],
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "Number of results to fetch",
      "schema": {
        "default": 20,
        "example": 20,
        "format": "int32",
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "name": "fids",
      "in": "query",
      "required": false,
      "description": "Comma separated list of FIDs, up to 100 at a time. If you pass in FIDs, you will get back the notification tokens for those FIDs. If you don't pass in FIDs, you will get back all the notification tokens for the mini app.",
      "schema": {
        "example": "194, 191, 6131",
        "type": "string",
        "x-accept-as": "integer",
        "x-comma-separated": true
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "required": false,
      "description": "Pagination cursor",
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "Success",
      "schema": {
        "$ref": "#/components/schemas/FrameNotificationTokens"
      },
      "example": null
    },
    "400": {
      "description": "Bad Request",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    }
  }
}