Developers
  • Welcome!
  • API
    • Quick Start
    • Authentication
    • Responses
    • Pagination
    • Reference
      • Announcements
      • Announcement Categories
      • Ideas
      • Statuses
      • Topics
      • Followers
      • Votes
      • --- Coming soon ---
      • Comments
      • Notes
Powered by GitBook
On this page
  1. API
  2. Reference

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

PreviousTopicsNextVotes

Last updated 7 months ago

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

Search for a follower

Create Follower

Delete a follower

get

Returns a list of followers

Authorizations
Query parameters
limitintegerOptional

Limits the number of items on a page

Default: 20
afterstringOptional

The after cursor - used for pagination

Responses
200
Successfully returned a list of followers
application/json
400
Invalid request
application/json
get
GET /v1/followers HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Accept: */*

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

Search for a followers

Authorizations
Query parameters
emailstringRequired
Responses
200
Successfully returned a list of followers
application/json
400
Invalid request
application/json
get
GET /v1/followers/search HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Accept: */*

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

Delete a follower

Authorizations
Path parameters
followerIdxstringRequired
Responses
200
Request was successful
application/json
400
Invalid request
application/json
delete
DELETE /v1/followers/{followerIdx} HTTP/1.1
Host: api.frill.co
Authorization: Basic username:password
Accept: */*

{
  "success": true,
  "message": "Request was successful"
}
  • Follower object
  • Endpoints
  • GET/followers
  • GET/followers/search
  • POST/followers
  • DELETE/followers/{followerIdx}
post

Create a new follower

Authorizations
Body
namestringRequired

Name of the follower

Example: John Smith
emailstringRequired

Email address of the follower

Example: john@example.com
Responses
200
Successfully created a new follower
application/json
400
Invalid request
application/json
post
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": "john@example.com"
}
{
  "data": {
    "idx": "follower_abcd1234",
    "name": "John Smith",
    "email": "john@example.com",
    "avatar": "https://example.com/example.jpg",
    "created_at": "text",
    "updated_at": "text"
  }
}