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
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
Limits the number of items on a page
20
The after cursor - used for pagination
Successfully returned a list of followers
Invalid request
GET /v1/followers HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Accept: */*
{
"data": [
{
"idx": "follower_abcd1234",
"name": "John Smith",
"email": "[email protected]",
"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
Successfully returned a list of followers
Invalid request
GET /v1/followers/search HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Accept: */*
{
"data": [
{
"idx": "follower_abcd1234",
"name": "John Smith",
"email": "[email protected]",
"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
Name of the follower
John Smith
Successfully created a new follower
Invalid request
POST /v1/followers HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"name": "John Smith",
"email": "[email protected]"
}
{
"data": {
"idx": "follower_abcd1234",
"name": "John Smith",
"email": "[email protected]",
"avatar": "https://example.com/example.jpg",
"created_at": "text",
"updated_at": "text"
}
}
Delete a follower
Delete a follower
Request was successful
Invalid request
DELETE /v1/followers/{followerIdx} HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Accept: */*
{
"success": true,
"message": "Request was successful"
}
Last updated