Followers

Followers represent the users that have interacted with your board or follow ideas or announcements for updates - also known 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

GEThttps://api.frill.co/v1/followers

Query parameters

Response

200400

Successfully returned a list of followers

Body

application/json

dataarray of Follower (object)

paginationPagination (object)

Request

JavaScriptCurl

const response = await fetch('https://api.frill.co/v1/followers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Search for a follower

Search for a followers

GEThttps://api.frill.co/v1/followers/search

Query parameters

Response

200400

Successfully returned a list of followers

Body

application/json

dataarray of Follower (object)

paginationPagination (object)

Request

JavaScriptCurl

const response = await fetch('https://api.frill.co/v1/followers/search', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Delete a follower

Delete a follower

DELETEhttps://api.frill.co/v1/followers/{followerIdx}

Path parameters

followerIdx*string

Response

200400

Request was successful

Body

application/json

successboolean

messagestring

Request

JavaScriptCurl

const response = await fetch('https://api.frill.co/v1/followers/{followerIdx}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

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