Help Center Articles

Get Help Center Article

Get a help center article by its ID

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage company resources (company_admin)View help articles (help_center_article:read)-
get/v1/help-center-articles/{id}

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

idinteger required

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

No recorded changes to this operation across all 1 revision of this API.