Learn

The Learn Hub provides curated articles to help users get the most out of HelpGenie. Progress is tracked per user — viewing an article automatically updates last_viewed_at, and users can explicitly mark articles complete or incomplete. Only published articles are returned.

Actions

`all` / `list`

Returns a paginated list of published articles with the current user’s progress joined.

number

default:"100"

Max results per page. Maximum 500.

number

default:"0"

Pagination offset.

object

Show filter properties

boolean

Only return “Start Here” articles.

string

Filter by category slug.

string

Case-insensitive title search.

boolean

Shorthand for filters.startHere.

Response

{
  "articles": [
    {
      "id": "article-uuid",
      "title": "Getting started with your first Genie",
      "slug": "getting-started-first-genie",
      "category": "setup",
      "is_start_here": true,
      "order_index": 1,
      "completed_at": null,
      "last_viewed_at": "2024-01-05T10:00:00Z"
    }
  ],
  "count": 24,
  "limit": 100,
  "offset": 0
}

`get`

Returns a single published article by slug (preferred) or id. Automatically records last_viewed_at for the current user as a side effect. Parameters

Field	Type	Required	Description
`slug`	string	Conditional	Article slug — preferred lookup key
`id`	string	Conditional	Article UUID — used if `slug` is not provided

At least one of slug or id is required. Response

{
  "article": {
    "id": "article-uuid",
    "title": "Getting started with your first Genie",
    "slug": "getting-started-first-genie",
    "category": "setup",
    "is_start_here": true,
    "order_index": 1,
    "body_markdown": "## Introduction\n\nWelcome to HelpGenie...",
    "completed_at": null,
    "last_viewed_at": "2024-01-07T10:00:00Z"
  }
}

`progress`

Returns all progress records for the current user — one entry per article they have viewed or completed. Parameters — none Response

{
  "progress": [
    {
      "article_id": "article-uuid",
      "completed_at": "2024-01-06T09:00:00Z",
      "last_viewed_at": "2024-01-06T09:00:00Z"
    }
  ]
}

`mark-complete`

Marks an article as completed for the current user. Sets both completed_at and last_viewed_at to now. Parameters

Field	Type	Required	Description
`id`	string	Conditional	Article UUID (request ID)
`articleId`	string	Conditional	Article UUID (data field) — used if `id` not provided

Response

{
  "success": true,
  "article_id": "article-uuid",
  "completed_at": "2024-01-07T10:00:00Z"
}

`mark-incomplete`

Clears the completed_at timestamp for an article, marking it as not completed. Parameters

Field	Type	Required	Description
`id`	string	Conditional	Article UUID (request ID)
`articleId`	string	Conditional	Article UUID (data field)

Response

{
  "success": true,
  "article_id": "article-uuid"
}

Error codes

Code	Meaning
`VALIDATION_ERROR`	Missing article ID or slug
`NOT_FOUND`	Article not found or not published
`INTERNAL_ERROR`	Unexpected server error

Overview

Public (unauthenticated)

Agents

Knowledge

CRM

Marketplace

Platform

Telephony

Worker genies

Quality & Compliance

Access Control

Intelligence

Education

Voice

Integrations

Expanded Platform

Actions

`all` / `list`

`get`

`progress`

`mark-complete`

`mark-incomplete`

Error codes

​Actions

​all / list

​get

​progress

​mark-complete

​mark-incomplete

​Error codes

Actions

`all` / `list`

`get`

`progress`

`mark-complete`

`mark-incomplete`

Error codes