Skip to main content

Try the live demo!

Search

Get Public Help Center Article

GET /api/v1/public/help-centers/{slug}/articles/{article_slug}

Authentication

This endpoint needs no authentication.

Parameters

Name Location Type Required Description
slug path string Yes Help center slug.
article_slug path string Yes Article slug.
locale query string No Locale code. Falls back to the help center's default locale when missing or not allowed.

Responses

200

Published article retrieved successfully

Content type: application/json.

All fields are optional.

Field Type Description
status string example: "success"
data object
data.id integer example: 1
data.created_at string (date-time) example: "2025-08-28T10:00:00Z"
data.updated_at string (date-time) example: "2025-08-28T10:00:00Z"
data.collection_id integer example: 1
data.author_id integer nullable: true
data.author_name string nullable: true
data.author_avatar string nullable: true
data.created_by integer nullable: true
data.created_by_name string nullable: true
data.slug string example: "reset-password"
data.locale string example: "en"
data.title string example: "Reset your password"
data.content string example: "<p>...</p>"
data.excerpt string example: ""
data.meta_title string example: ""
data.meta_description string example: ""
data.meta_image_url string example: ""
data.sort_order integer example: 0
data.status string example: "published"
data.view_count integer example: 0
data.ai_enabled boolean example: false
data.helpful_count integer example: 0
data.not_helpful_count integer example: 0

404

Not found

Content type: application/json.

All fields are optional.

Field Type Description
status string example: "error"
message string Error message example: "Invalid request"
data unspecified Additional error data nullable: true
error_type string (enum) enum: ["GeneralException", "PermissionException", "InputException", "DataException", "NetworkException", "NotFoundException", "ConflictException", "UnauthorizedException", "RateLimitException"]

429

Rate limit exceeded

Content type: application/json.

Response fields match the 404 response.

500

Internal server error

Content type: application/json.

Response fields match the 404 response.

Specification

Download the complete OpenAPI specification.

OpenAPI definition for this endpoint
openapi: 3.0.0
info:
  title: libredesk API
  description: >-
    REST API documentation for libredesk helpdesk system.


    ## Authentication


    The libredesk API supports two authentication methods:


    ### 1. Basic Authentication

    Use your API key and secret with Basic authentication:

    ```

    Authorization: Basic <base64_encoded_api_key:api_secret>

    ```


    ### 2. Token Authentication  

    Use your API key and secret with token authentication:

    ```

    Authorization: token api_key:api_secret

    ```


    To obtain API credentials, generate them from your agent profile in the
    libredesk dashboard.
  version: 1.0.0
servers:
  - url: http://localhost:8080
    description: Local development server
security:
  - basicAuth: []
  - tokenAuth: []
paths:
  /api/v1/public/help-centers/{slug}/articles/{article_slug}:
    get:
      tags:
        - Help center
      summary: Get Public Help Center Article
      operationId: handleGetPublicHelpCenterArticle
      parameters:
        - name: slug
          in: path
          required: true
          schema:
            type: string
          description: Help center slug.
        - name: article_slug
          in: path
          required: true
          schema:
            type: string
          description: Article slug.
        - name: locale
          in: query
          required: false
          schema:
            type: string
          description: >-
            Locale code. Falls back to the help center's default locale when
            missing or not allowed.
      responses:
        '200':
          description: Published article retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HelpCenterArticleResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
components:
  schemas:
    HelpCenterArticleResponse:
      type: object
      properties:
        status:
          type: string
          example: success
        data:
          $ref: '#/components/schemas/HelpCenterArticle'
    ErrorResponse:
      type: object
      description: Error response format
      properties:
        status:
          type: string
          example: error
        message:
          type: string
          description: Error message
          example: Invalid request
        data:
          nullable: true
          description: Additional error data
        error_type:
          type: string
          enum:
            - GeneralException
            - PermissionException
            - InputException
            - DataException
            - NetworkException
            - NotFoundException
            - ConflictException
            - UnauthorizedException
            - RateLimitException
    HelpCenterArticle:
      type: object
      properties:
        id:
          type: integer
          example: 1
        created_at:
          type: string
          format: date-time
          example: '2025-08-28T10:00:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2025-08-28T10:00:00Z'
        collection_id:
          type: integer
          example: 1
        author_id:
          type: integer
          nullable: true
        author_name:
          type: string
          nullable: true
        author_avatar:
          type: string
          nullable: true
        created_by:
          type: integer
          nullable: true
        created_by_name:
          type: string
          nullable: true
        slug:
          type: string
          example: reset-password
        locale:
          type: string
          example: en
        title:
          type: string
          example: Reset your password
        content:
          type: string
          example: <p>...</p>
        excerpt:
          type: string
          example: ''
        meta_title:
          type: string
          example: ''
        meta_description:
          type: string
          example: ''
        meta_image_url:
          type: string
          example: ''
        sort_order:
          type: integer
          example: 0
        status:
          type: string
          example: published
        view_count:
          type: integer
          example: 0
        ai_enabled:
          type: boolean
          example: false
        helpful_count:
          type: integer
          example: 0
        not_helpful_count:
          type: integer
          example: 0
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >-
        Basic authentication using base64 encoded API key and secret. Format:
        `Authorization: Basic <base64(api_key:api_secret)>`
    tokenAuth:
      type: apiKey
      name: Authorization
      in: header
      description: >-
        Token authentication using API key and secret. Format: `Authorization:
        token api_key:api_secret`

Was this article helpful?