Sign in

v1

latestOpenAPI 3.0.42026-07-26159287356.1 KB
Channel

Open invites

Fetch a list of invites, either in a channel or for a user. If both are provided, open channel invite for that user is returned.

get/v2/farcaster/channel/member/invite/list/

Query parameters

channel_idstring
Example:neynar

Channel ID for the channel being queried

invited_fidinteger

FID of the user being invited

limitinteger
Example:30

Number of results to fetch

cursorstring

Pagination cursor.

Response

Success

Example response

{
  "invites": [
    {
      "channel_id": "neynar",
      "invited": {
        "auth_addresses": [
          {
            "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "app": {
              "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
              "fid": 3
            }
          }
        ],
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "fid": 3,
        "profile": {
          "bio": {
            "mentioned_profiles": [
              {
                "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
                "fid": 3
              }
            ]
          }
        },
        "verifications": [
          "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          ],
          "primary": {
            "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          }
        }
      },
      "inviter": {
        "auth_addresses": [
          {
            "address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
            "app": {
              "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
              "fid": 3
            }
          }
        ],
        "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
        "fid": 3,
        "profile": {
          "bio": {
            "mentioned_profiles": [
              {
                "custody_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
                "fid": 3
              }
            ]
          }
        },
        "verifications": [
          "0x5a927ac639636e534b678e81768ca19e2c6280b7"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          ],
          "primary": {
            "eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7"
          }
        }
      }
    }
  ]
}