Show Article Subscription

GET {{baseUrl}}/api/v2/help_center/:locale/articles/:article_id/subscriptions/:subscription_id

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 only show a subscription created by the requesting end-user.

Sideloads

The following sideloads are supported:

NameWill sideloadFor
usersusersall
articlesarticlesarticle subscriptions
sectionssectionssection subscriptions

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"subscription":{"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"}}