Followers

Followers are users who have engaged with your board or are tracking specific Ideas or Announcements for updates. These users are often referred to as tracked users

Follower object

Followers have the following fields

Field	Details
idx string	A unique identifier for the follower
name string	Name of the follower
avatar number	Profile image of the follower (URL)
email number	Email address
created_at number	Date the follower was created
updated_at number	Date the follower was last updated

Endpoints

You can use the following endpoints to manage Topics

List followers

Returns a list of followers

get

/followers

Authorizations

Query parameters

limitinteger · default: 20

Limits the number of items on a page

afterstring

The after cursor - used for pagination

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.frill.co/v1/followers' \
  --header 'Authorization: Basic username:password'

200

400

200

{
  "pagination": {
    "total": 10,
    "before": "before-cursor",
    "after": "after-cursor"
  },
  "data": [
    {
      "idx": "follower_abcd1234",
      "name": "John Smith",
      "email": "[e-mail]",
      "avatar": "https://example.com/example.jpg",
      "created_at": "text",
      "updated_at": "text"
    }
  ]
}

Successfully returned a list of followers

Search for a follower

Search for a followers

get

/followers/search

Authorizations

Query parameters

emailstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.frill.co/v1/followers/search?email=text' \
  --header 'Authorization: Basic username:password'

200

400

200

{
  "pagination": {
    "total": 10,
    "before": "before-cursor",
    "after": "after-cursor"
  },
  "data": [
    {
      "idx": "follower_abcd1234",
      "name": "John Smith",
      "email": "[e-mail]",
      "avatar": "https://example.com/example.jpg",
      "created_at": "text",
      "updated_at": "text"
    }
  ]
}

Successfully returned a list of followers

Create Follower

Create a new follower

post

/followers

Authorizations

Body

namestringrequired

Name of the follower

Example: John Smith

emailstringrequired

Email address of the follower

Example: [e-mail]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.frill.co/v1/followers' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{"name":"John Smith","email":"[e-mail]"}'

200

400

200

{
  "data": {
    "idx": "follower_abcd1234",
    "name": "John Smith",
    "email": "[e-mail]",
    "avatar": "https://example.com/example.jpg",
    "created_at": "text",
    "updated_at": "text"
  }
}

Successfully created a new follower

Delete a follower

Delete a follower

delete

/followers/{followerIdx}

Authorizations

Path parameters

followerIdxstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.frill.co/v1/followers/{followerIdx}' \
  --header 'Authorization: Basic username:password'

200

400

200

{
  "success": true,
  "message": "Request was successful"
}

Request was successful