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

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

JavaScriptCurlPython

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

Response

200400

{
  "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

JavaScriptCurlPython

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

Response

200400

{
  "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"
  }
}

Create Follower

Create a new follower

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

Body

application/json

name*string

Name of the follower

Example: "John Smith"

email*string

Email address of the follower

Example: "[e-mail]"

Response

200400

Successfully created a new follower

Body

application/json

dataFollower (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.frill.co/v1/followers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "John Smith",
      "email": "[e-mail]"
    }),
});
const data = await response.json();

Response

200400

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

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

Example: "Request was successful"

Request

JavaScriptCurlPython

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

Response

200400

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