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

List followers

get

Returns a list of followers

Authorizations

BearerAuthBasicAuthApiKeyQuery

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Query parameters

limitintegerOptional

Limits the number of items on a page

Default: 20

afterstringOptional

The after cursor - used for pagination

include_attributesbooleanOptional

Include custom attributes in the response

Responses

200

Successfully returned a list of followers

application/json

400

Invalid request

application/json

get

/followers

HTTPcURLJavaScriptPython

GET /v1/followers HTTP/1.1
Host: api.frill.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "idx": "follower_abcd1234",
      "name": "John Smith",
      "email": "[email protected]",
      "avatar": "https://example.com/example.jpg",
      "attributes": {
        "job_title": "Product Manager",
        "birth_date": "1990-05-15",
        "department": "Engineering"
      },
      "created_at": "text",
      "updated_at": "text"
    }
  ],
  "pagination": {
    "total": 10,
    "before": "before-cursor",
    "after": "after-cursor"
  }
}

Search for a follower

Search followers

get

Search for followers by email

Authorizations

BearerAuthBasicAuthApiKeyQuery

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Query parameters

emailstringRequired

include_attributesbooleanOptional

Include custom attributes in the response

Responses

200

Successfully returned a list of followers

application/json

400

Invalid request

application/json

get

/followers/search

HTTPcURLJavaScriptPython

GET /v1/followers/search?email=text HTTP/1.1
Host: api.frill.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "idx": "follower_abcd1234",
      "name": "John Smith",
      "email": "[email protected]",
      "avatar": "https://example.com/example.jpg",
      "attributes": {
        "job_title": "Product Manager",
        "birth_date": "1990-05-15",
        "department": "Engineering"
      },
      "created_at": "text",
      "updated_at": "text"
    }
  ],
  "pagination": {
    "total": 10,
    "before": "before-cursor",
    "after": "after-cursor"
  }
}

Create Follower

Create a follower

post

Create a new follower

Authorizations

BearerAuthBasicAuthApiKeyQuery

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Body

application/json

namestringRequired

Name of the follower

Example: John Smith

emailstringRequired

Email address of the follower

Example: [email protected]

attributesobjectOptional

Custom attributes for the follower (key-value pairs)

Example: {"job_title":"Product Manager","birth_date":"1990-05-15","department":"Engineering"}

Responses

200

Successfully created a new follower

application/json

400

Invalid request

application/json

403

Custom attributes not enabled (when attributes or companies are provided)

application/json

post

/followers

HTTPcURLJavaScriptPython

POST /v1/followers HTTP/1.1
Host: api.frill.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 287

{
  "name": "John Smith",
  "email": "[email protected]",
  "attributes": {
    "job_title": "Product Manager",
    "birth_date": "1990-05-15",
    "department": "Engineering"
  },
  "companies": [
    {
      "id": 1,
      "name": "Acme",
      "monthly_spend": 50,
      "plan": "Business"
    },
    {
      "id": 2,
      "name": "TechCorp",
      "monthly_spend": 150,
      "plan": "Enterprise"
    }
  ]
}

{
  "data": {
    "idx": "follower_abcd1234",
    "name": "John Smith",
    "email": "[email protected]",
    "avatar": "https://example.com/example.jpg",
    "attributes": {
      "job_title": "Product Manager",
      "birth_date": "1990-05-15",
      "department": "Engineering"
    },
    "created_at": "text",
    "updated_at": "text"
  }
}

Update Follower

Update a follower

post

Update an existing follower

Authorizations

BearerAuthBasicAuthApiKeyQuery

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Path parameters

followerIdxstringRequired

The unique identifier for the follower

Body

application/json

namestringOptional

Name of the follower (optional)

Example: John Smith

emailstringOptional

Email address of the follower (optional)

Example: [email protected]

attributesobjectOptional

Custom attributes to merge with existing attributes (key-value pairs, optional)

Example: {"job_title":"Senior Product Manager","department":"Product","location":"San Francisco"}

Responses

200

Successfully updated the follower

application/json

400

Invalid request

application/json

403

Custom attributes not enabled

application/json

404

Follower not found

application/json

post

/followers/{followerIdx}

HTTPcURLJavaScriptPython

POST /v1/followers/{followerIdx} HTTP/1.1
Host: api.frill.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 227

{
  "name": "John Smith",
  "email": "[email protected]",
  "attributes": {
    "job_title": "Senior Product Manager",
    "department": "Product",
    "location": "San Francisco"
  },
  "companies": [
    {
      "id": 1,
      "name": "Acme",
      "monthly_spend": 100,
      "plan": "Enterprise"
    }
  ]
}

{
  "data": {
    "idx": "follower_abcd1234",
    "name": "John Smith",
    "email": "[email protected]",
    "avatar": "https://example.com/example.jpg",
    "attributes": {
      "job_title": "Product Manager",
      "birth_date": "1990-05-15",
      "department": "Engineering"
    },
    "created_at": "text",
    "updated_at": "text"
  }
}

Delete a follower

Delete a follower

delete

Delete a follower

Authorizations

BearerAuthBasicAuthApiKeyQuery

AuthorizationstringRequired

API key in Authorization header with Bearer prefix (recommended)

Path parameters

followerIdxstringRequired

The unique identifier for the follower

Query parameters

contentstring · enumOptional

Action to take with follower's content: 'delete' removes all content, 'reassign' transfers content to an anonymous user

Default: deletePossible values:

Responses

200

Request was successful

application/json

400

Invalid request

application/json

delete

/followers/{followerIdx}

HTTPcURLJavaScriptPython

DELETE /v1/followers/{followerIdx} HTTP/1.1
Host: api.frill.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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