GET
/
users
curl --request GET \
  --url https://api.pinata.cloud/v3/farcaster/users \
  --header 'Authorization: Bearer <token>'
{
  "next": {
    "cursor": "eyJ0aW1lc3RhbXAiOiIyMDI0LTA1LTE0IDE2OjAyOjUzLjAwMDAwMDAiLCJmaWQiOjUzMDM1OH0%3D"
  },
  "users": [
    {
      "object": "follow",
      "user": {
        "active_status": "inactive",
        "custody_address": "0x23cb10e59422eb93ababff06401eec0691cb95b8",
        "display_name": "Abimbola",
        "fid": 530358,
        "follower_count": 300,
        "following_count": 554,
        "notes": {
          "active_status": "Warpcast has transitioned from active badges to power badges, Neynar will deprecate this key in the user object in the next few weeks"
        },
        "object": "user",
        "pfp_url": "https://imagedelivery.net/BXluQx4ige9GuW0Ia56BHw/0e1f6e5a-ae62-4548-0f42-197ec91d6500/rectcrop3",
        "power_badge": false,
        "profile": {
          "bio": {
            "text": "I'm a sweet girl that love Jesus, An ambitious lady and a big purrrr"
          }
        },
        "username": "!530358",
        "verifications": [
          "0x4e71e0f4216924c995d43465ac0bb3d5967e764e"
        ],
        "verified_addresses": {
          "eth_addresses": [
            "0x4e71e0f4216924c995d43465ac0bb3d5967e764e"
          ],
          "sol_addresses": []
        }
      }
    }
  ]
}

This endpoint is similar to /casts in that you can either fetch a specific user by FID or you can combine multiple query parameters to get specific lists of users.

​
Users Following FID

/users?fid=6023&followers=true

Returns all the users following a specific FID

​
Users FID Following

/users?fid=6023&following=true

Returns all the users a specific FID is following

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
fid
integer

Used in combination with followers and following

Example:

4823

​
followers
boolean

When used with fid will return the followers of the specified fid

Example:

true

​
following
boolean

When used with fid will return the users fid is following

Example:

true

​
pageSize
integer

Determine the number of results, if not specified default is 100

Example:

1

​
pageToken
string

Token to be used for the next page of results

Example:

"eyJvZmZzZXQiOiIyMyJ9"

Response

200 - application/json

OK

The response is of type object.