Get Help Center Article
Changed onGet a help center article by its ID
Authentication
This endpoint accepts any one of the following token types:
- Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
- Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.
Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage company resources (company_admin) | View help articles (help_center_article:read) | - |
Request
- Base URL: https://gateway.remote.com
- URL: https://gateway.remote.com/v1/help-center-articles/{id}
- Auth: OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, help_center_article:read, company_admin, all:write, all:read) and OAuth 2 (client credentials, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, help_center_article:read, company_admin, all:write, all:read)
Path parameters
Help Center Article Zendesk ID
Response
Success
Example response
{
"data": {
"help_center_article": {
"body": "Help Center Article Body",
"html_url": "https://www.example.com",
"title": "Help Center Article",
"zendesk_id": 12345679
}
}
}Changes
- info
the security scope
company_adminwas added to the endpoint's security schemeOAuth2AuthorizationCode - info
the security scope
company_adminwas added to the endpoint's security schemeOAuth2ClientCredentials - info
the security scope
company_managementwas removed from the endpoint's security schemeOAuth2AuthorizationCode - info
the security scope
company_managementwas removed from the endpoint's security schemeOAuth2ClientCredentials
- info
- info
the security scope
company_managementwas added to the endpoint's security schemeOAuth2AuthorizationCode - info
the security scope
company_managementwas added to the endpoint's security schemeOAuth2ClientCredentials - info
the security scope
company_adminwas removed from the endpoint's security schemeOAuth2AuthorizationCode - info
the security scope
company_adminwas removed from the endpoint's security schemeOAuth2ClientCredentials
- info