Help Center Articles

Get Help Center Article

Get 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, acting as the user who authorized it. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.
  • Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.
  • Client token (ClientToken) — a partner client_token, accepted only on the endpoints that list it. See Authentication for partners.
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: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token
    • or HTTP bearer
    • or HTTP bearer

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.