Skip to content
Developers
GuidesAPI reference
slimwiki.comGet an API key

Guides

  • Quickstart
  • Authentication
  • Errors
  • Pagination
  • Rate limits
  • Content format
  • Versioning

Tools and agents

  • CLI
  • MCP server
  • Agent skill

API reference

  • Overview

Users

  • Retrieve the key ownerget

Accounts

  • List accountsget

Wikis

  • List wikisget
  • Retrieve a wikiget

Pages

  • List pages in a wikiget
  • Search pages in a wikiget
  • Find a page by slug or hashget
  • Create a pagepost
  • Retrieve a pageget
  • Delete a pagedelete
  • Archive a pagepost
  • Restore a pagepost

Guides

Pagination

Endpoints that return several items all use the same list object. Lists of pages are split into numbered pages that you request one at a time.

On this page

  • The list object
  • Paging through pages
  • Fetching every result

The list object

A list response always has these three fields:

  • object is always "list".
  • data is the array of items.
  • has_more says whether another page of results exists after this one.
Response · 200
{
  "object": "list",
  "data": [
    {
      "object": "account",
      "id": "c4a7e2b8-5d3f-4a16-9c0e-7b2f1d8a6e45",
      "name": "Acme",
      "slug": "acme",
      "role": "owner",
      "default_wiki_id": "6f1c2d0e-8a3b-4c5d-9e7f-0a1b2c3d4e5f"
    }
  ],
  "has_more": false
}

These endpoints return a list and take no pagination parameters:

  • get/v1/accounts (List accounts)
  • get/v1/wikis (List wikis)

Paging through pages

Endpoints that list wiki pages return one page of results at a time. Their responses add three fields to the list object: page (the page number returned), page_size (the page size used) and total (the total number of matching items).

Response · 200
{
  "object": "list",
  "data": [
    {
      "object": "page",
      "id": "a3d8f1c6-2b4e-4f7a-8d9c-5e6f7a8b9c0d",
      "wiki_id": "6f1c2d0e-8a3b-4c5d-9e7f-0a1b2c3d4e5f",
      "title": "Release checklist",
      "slug": "release-checklist",
      "hash": "string",
      "archived": false,
      "updated_at": "2026-01-14T16:05:00.000Z"
    }
  ],
  "has_more": false,
  "page": 1,
  "page_size": 20,
  "total": 1
}

Two query parameters control which results you get:

  • page: Page number, starting at 1.
  • page_size: the number of items per page. The default and the maximum depend on the endpoint:
Default and maximum page size per endpoint
EndpointDefault page sizeMaximum page size
get/v1/wikis/{wiki_id}/pages
List pages in a wiki
20100
get/v1/wikis/{wiki_id}/pages/search
Search pages in a wiki
2050

Fetching every result

Start at page 1 and keep requesting the next page number while has_more is true. Keep page_size the same for every request.

Request
curl "https://api.slimwiki.com/v1/wikis/6f1c2d0e-8a3b-4c5d-9e7f-0a1b2c3d4e5f/pages?page=2&page_size=50" \
  -H "Authorization: Bearer $SLIMWIKI_API_KEY"

Each request counts towards your rate limit, so a larger page size means fewer requests for the same data.

Previous

Errors
The error response body, every error code and the HTTP status it comes with.

Next

Rate limits
How many requests a key can make, the rate limit headers and what to do on a 429.

SlimWiki Developers

slimwiki.com