List Article Subscriptions
GET {{baseUrl}}/api/v2/help_center/:locale/articles/:article_id/subscriptions
Lists the subscriptions to a given article.
Note: {/locale} is an optional parameter for admins and agents. End users and anonymous users must provide the parameter.
Allowed for
- End users
For end-users, the response will list only the subscriptions created by the requesting end-user.
Pagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
Sideloads
The following sideloads are supported:
| Name | Will sideload |
|---|---|
| users | users |
| articles | articles |
| sections | sections |
Note that you need to specify the articles sideload to get the sections
and translations sideloaded because these are not directly associated with the
subscriptions.
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"subscriptions":[{"locale":"\u003cstring\u003e","content_id":"\u003cinteger\u003e","content_type":"\u003cstring\u003e","created_at":"\u003cstring\u003e","id":"\u003cinteger\u003e","include_comments":"\u003cboolean\u003e","source_locale":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","url":"\u003cstring\u003e","user_id":"\u003cinteger\u003e"},{"locale":"\u003cstring\u003e","content_id":"\u003cinteger\u003e","content_type":"\u003cstring\u003e","created_at":"\u003cstring\u003e","id":"\u003cinteger\u003e","include_comments":"\u003cboolean\u003e","source_locale":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","url":"\u003cstring\u003e","user_id":"\u003cinteger\u003e"}]}