List sites

List the workspace’s help sites, each with its topics and their articles, draft or published, and their public addresses.

GET/v1/w/{workspace}/help-sites

Path parameters

workspacestringrequired

Your workspace’s address name.

Query parameters

cursorstring

The nextCursor from the previous page; leave out for the first page.

limitinteger

How many sites to return, 1 to 200. Defaults to 50.

siteIdstring

Only this site.

Response

sitesobject[]required

nextCursorstring | null

liveboolean

Whether public pages are on for the workspace.

Details

List the workspace's help sites: each site's address, whether readers can open it (live), and its topics with their articles. An article's status is published (readers see the page as it is), changed (published, but the page has edits readers do not see yet), draft (not published), orphan or missing (its page is in Trash or gone, so readers cannot see it). Read an article with get_help_article, or its page (with drafts) with get_page.

Since 2026-12. Errors are listed in Errors.

cURL

curl "https://api.olamma.sh/v1/w/your-workspace/help-sites" \
  -H "Authorization: Bearer $OLAMMA_KEY"

Response 200

{
  "sites": [
    {
      "id": "<string>",
      "name": "<string>",
      "url": "<string>",
      "live": true,
      "project": "<string>",
      "topics": [
        {
          "id": "<string>",
          "title": "<string>",
          "url": "<string>",
          "articles": [
            {
              "id": null,
              "title": null,
              "status": null,
              "url": null,
              "pageId": null
            }
          ]
        }
      ]
    }
  ],
  "nextCursor": "<string>",
  "live": true
}