Help Center API Reference

Help Center API

The Help Center API is a versioned internal REST API used by the OnCodes support platform. It allows you to programmatically manage articles, categories, and sections. All endpoints are prefixed with /api/v1/hc/ and require an active authenticated session.

Base URL

https://support.oncodes.com/api/v1/hc/

Authentication

All requests require a valid browser session cookie and the CSRF token passed as a request header. The token is stored in the XSRF-TOKEN cookie and must be decoded before use.

X-XSRF-TOKEN: <decoded value of XSRF-TOKEN cookie>
Content-Type: application/json
Accept: application/json

To extract the token in the browser console:

decodeURIComponent(document.cookie.match(/XSRF-TOKEN=([^;]+)/)[1])

Articles

List Articles

Endpoint: GET /api/v1/hc/articles

Returns a paginated list of articles. Supports filtering, searching, and sorting.

Query Parameters

Response

{
  "pagination": {
    "current_page": 1,
    "per_page": 15,
    "total": 76,
    "last_page": 6,
    "from": 1,
    "to": 15,
    "next_page": 2,
    "prev_page": null,
    "data": [
      {
        "id": 101,
        "title": "Article Title",
        "slug": "article-title",
        "draft": false,
        "updated_at": "2026-02-26T08:00:00.000000Z",
        "used_by_ai_agent": false,
        "author": { "id": 1, "name": "..." },
        "tags": [],
        "path": [
          { "id": 1, "name": "ChatNet", "model_type": "category", "is_section": false },
          { "id": 2, "name": "Getting Started", "model_type": "category", "is_section": true }
        ]
      }
    ]
  },
  "status": "success"
}

Get Article

Endpoint: GET /api/v1/hc/articles/{id}

Returns a single article including full body content, navigation context, and category path.

Response

{
  "article": {
    "id": 101,
    "title": "Article Title",
    "body": "<p>HTML content...</p>",
    "slug": "article-title",
    "draft": false,
    "visibility": "public",
    "views": 0,
    "position": 0,
    "description": null,
    "extra_data": null,
    "managed_by_role": null,
    "visible_to_role": null,
    "author_id": 1,
    "scan_pending": false,
    "used_by_ai_agent": 0,
    "created_at": "2026-02-26T08:00:00.000000Z",
    "updated_at": "2026-02-26T08:00:00.000000Z",
    "model_type": "article",
    "categories": [...],
    "tags": [],
    "attachments": []
  },
  "categoryNav": {...},
  "pageNav": {...},
  "status": "success"
}

Create Article

Endpoint: POST /api/v1/hc/articles

Creates a new article. Returns 201 Created on success.

Request Body

Validation Errors (422)

Example Request

fetch('https://support.oncodes.com/api/v1/hc/articles', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'X-XSRF-TOKEN': decodeURIComponent(document.cookie.match(/XSRF-TOKEN=([^;]+)/)[1])
  },
  body: JSON.stringify({
    title: 'My New Article',
    body: '<p>Content here</p>',
    author_id: 1,
    sections: [2],
    draft: false,
    tags: []
  })
});

Response

HTTP 201 Created
{
  "article": {
    "id": 102,
    "title": "My New Article",
    "body": "<p>Content here</p>",
    "draft": false,
    ...
  },
  "status": "success"
}

Update Article

Endpoint: PUT /api/v1/hc/articles/{id}

Updates an existing article. Accepts the same fields as Create Article. Note: PATCH is not supported — use PUT.

Supported Methods

Only GET, PUT, and DELETE are supported on /api/v1/hc/articles/{id}. Using PATCH returns 405 Method Not Allowed.

Delete Article

Endpoint: DELETE /api/v1/hc/articles/{id}

Permanently deletes an article. Returns 200 with {"status":"success"} even if the article does not exist.

Categories

In this platform, categories and sections share the same data model. A category is a top-level grouping (e.g. a product). A section is a child of a category (is_section: true, parent_id set). Articles are attached to sections, not directly to categories.

List Categories (Manager View)

Endpoint: GET /api/v1/hc/manager/categories

Returns all top-level categories used in the admin arrange view. Does not include children — fetch sections separately per category.

Response

{
  "categories": [
    {
      "id": 1,
      "name": "ChatNet - PHP Chat Room",
      "is_section": false,
      "parent_id": null,
      "description": "...",
      "image": "storage/category/image.png",
      "visible_to_role": null,
      "managed_by_role": null,
      "articles_count": 45,
      "sections_count": 11,
      "tags": []
    }
  ],
  "status": "success"
}

List Sections for a Category

Endpoint: GET /api/v1/hc/manager/categories/{categoryId}/sections

Returns all sections (child categories) belonging to a given top-level category.

Response

{
  "categories": [
    {
      "id": 2,
      "name": "Getting Started",
      "is_section": true,
      "parent_id": 1,
      "articles_count": 6
    }
  ],
  "category": { ... },
  "status": "success"
}

Create Category or Section

Endpoint: POST /api/v1/hc/categories

Creates a new category (top-level) or section (child). To create a section, set parent_id to the parent category ID and is_section to true.

Request Body

Response

HTTP 200 OK
{
  "category": {
    "id": 32,
    "name": "My Section",
    "parent_id": 1,
    "is_section": true,
    "position": 12,
    "created_at": "...",
    "updated_at": "...",
    "model_type": "category"
  },
  "status": "success"
}

Update Category or Section

Endpoint: PUT /api/v1/hc/categories/{id}

Updates an existing category or section. Accepts the same fields as Create. Returns the full updated category object.

Full Category Object Fields

The response includes: id, name, description, position, default, parent_id, managed_by_role, visible_to_role, hide_from_structure, is_section, image, created_at, updated_at, model_type.

Delete Category or Section

Endpoint: DELETE /api/v1/hc/categories/{id}

Permanently deletes a category or section. Returns 404 if the ID does not exist.

Note: POST and DELETE are not available on /api/v1/hc/manager/categories — use /api/v1/hc/categories instead.

Other Endpoints

Normalized Models (Lookup Data)

These endpoints return lightweight lists used to populate dropdowns and filters in the UI.

Arrange View

Endpoint: GET /api/v1/hc/manager/categories/arrange

Returns the category tree used to render the drag-and-drop arrange page at /dashboard/hc/arrange.

Current Category & Section Structure