User Subscriptions

Users can subscribe to other users. The subscriber is notified when the other user adds an article to a section, adds a comment to an article or a post, or adds a post to a topic.

JSON format

User Subscriptions are represented as JSON objects with the following properties:

Name Type Read-only Mandatory Description
followed_id integer true true The id of the user being followed
follower_id integer true true The id of the user doing the following
id integer true true Automatically assigned when the subscription is created


{  "followed_id": 65466,  "follower_id": 98354,  "id": 1635}

List User Subscriptions By User

  • GET /api/v2/help_center/users/{user_id}/user_subscriptions

Lists the user subscriptions of a given user. To list your own subscriptions, specify me as the user id.

Allowed for

  • Agents
  • End-users


  • Cursor pagination (recommended)
  • Offset pagination

See Pagination.


The following sideloads are supported:

Name Will sideload For
users users all


Name Type In Required Description
type string Query false Selects whether to find who the given user is following ("followings") or who is following the given user ("followers"). The default is "followers". Allowed values are "followings", or "followers".
user_id integer Path true The unique ID of the user

Code Samples

curl https://{subdomain}{user_id}/user_subscriptions.json \  -v -u {email_address}:{password}
import (	"fmt"	"io"	"net/http")
func main() {	url := ""	method := "GET"	req, err := http.NewRequest(method, url, nil)
	if err != nil {		fmt.Println(err)		return	}	req.Header.Add("Content-Type", "application/json")	req.Header.Add("Authorization", "Basic <auth-value>") // Base64 encoded "username:password"
	client := &http.Client {}	res, err := client.Do(req)	if err != nil {		fmt.Println(err)		return	}	defer res.Body.Close()
	body, err := io.ReadAll(res.Body)	if err != nil {		fmt.Println(err)		return	}	fmt.Println(string(body))}
import com.squareup.okhttp.*;OkHttpClient client = new OkHttpClient();HttpUrl.Builder urlBuilder = HttpUrl.parse("")		.newBuilder()		.addQueryParameter("type", "");
Request request = new Request.Builder()		.url(		.method("GET", null)		.addHeader("Content-Type", "application/json")		.addHeader("Authorization", Credentials.basic("your-email", "your-password"))		.build();Response response = client.newCall(request).execute();
var axios = require('axios');
var config = {  method: 'GET',  url: '',  headers: {	'Content-Type': 'application/json',	'Authorization': 'Basic <auth-value>', // Base64 encoded "username:password"  },  params: {    'type': '',  },};
axios(config).then(function (response) {  console.log(JSON.stringify(;}).catch(function (error) {  console.log(error);});
import requests
url = ""headers = {	"Content-Type": "application/json",}
response = requests.request(	"GET",	url,	auth=('<username>', '<password>'),	headers=headers)
require "net/http"uri = URI("")uri.query = URI.encode_www_form("type": "")request =, "Content-Type": "application/json")request.basic_auth "username", "password"response = Net::HTTP.start uri.hostname, uri.port, use_ssl: true do |http|	http.request(request)end

Example response(s)

200 OK
// Status 200 OK
{  "user_subscriptions": [    {      "followed_id": 8748733,      "follower_id": 398452,      "id": 35467    }  ]}