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


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

Using curl

curl https://{subdomain}{user_id}/user_subscriptions.json \  -v -u {email_address}:{password}

Example Response(s)

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