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

API reference / Pages

Search pages in a wiki

get/v1/wikis/{wiki_id}/pages/search

Full-text search over page titles and content, best match first.

Path parameters

Path parameters
ParameterDescription
wiki_id
string (uuid)required

The wiki ID.

Query parameters

Query parameters
ParameterDescription
query
stringrequired

The text to search for.

1 to 200 characters.

page
integeroptional

Page number, starting at 1.

Default 1. Minimum 1.

page_size
integeroptional

Items per page.

Default 20. 1 to 50.

archived
booleanoptional

Set to true to search archived pages instead. Only applies to wikis you are a member of.

Default false.

Responses

  • 200

    A page of results.

    Fields of the 200 response of Search pages in a wiki
    FieldDescription
    object
    string

    Always "list".

    data
    object[]
    —
    data[].object
    string

    Always "page".

    data[].id
    string (uuid)

    The page ID.

    data[].wiki_id
    string (uuid)

    The wiki the page belongs to.

    data[].title
    string
    —
    data[].slug
    string

    The page part of its SlimWiki URL.

    data[].hash
    string | nulloptional

    A short identifier that stays the same when the page is renamed. It is the last part of the page URL.

    data[].archived
    boolean
    —
    data[].updated_at
    string (date-time) | nulloptional

    When the page was last edited.

    has_more
    boolean

    Whether another page of results exists after this one.

    page
    integeroptional

    The page number returned.

    page_size
    integeroptional

    The page size used.

    total
    integeroptional

    Total number of matching items.

  • 400

    A query parameter is missing or not valid. Error code: invalid_request.

    Error body fields
    Fields of the 400 error body of Search pages in a wiki
    FieldDescription
    error
    object
    —
    error.code
    string

    A stable, machine-readable error code.

    One of invalid_request, unauthorized, insufficient_scope, forbidden, not_found, conflict, rate_limited, internal_error.

    error.message
    string

    A description for people. The wording may change.

    error.details
    object[]optional

    For invalid_request: the fields that failed validation.

    error.details[].field
    stringoptional
    —
    error.details[].message
    stringoptional
    —
    error.request_id
    string | nulloptional

    Quote this when contacting support.

  • 401

    The API key is missing, invalid, revoked or expired. Error code: unauthorized.

    Error body fields
    Fields of the 401 error body of Search pages in a wiki
    FieldDescription
    error
    object
    —
    error.code
    string

    A stable, machine-readable error code.

    One of invalid_request, unauthorized, insufficient_scope, forbidden, not_found, conflict, rate_limited, internal_error.

    error.message
    string

    A description for people. The wording may change.

    error.details
    object[]optional

    For invalid_request: the fields that failed validation.

    error.details[].field
    stringoptional
    —
    error.details[].message
    stringoptional
    —
    error.request_id
    string | nulloptional

    Quote this when contacting support.

  • 404

    The resource does not exist, or this API key cannot see it. Error code: not_found.

    Error body fields
    Fields of the 404 error body of Search pages in a wiki
    FieldDescription
    error
    object
    —
    error.code
    string

    A stable, machine-readable error code.

    One of invalid_request, unauthorized, insufficient_scope, forbidden, not_found, conflict, rate_limited, internal_error.

    error.message
    string

    A description for people. The wording may change.

    error.details
    object[]optional

    For invalid_request: the fields that failed validation.

    error.details[].field
    stringoptional
    —
    error.details[].message
    stringoptional
    —
    error.request_id
    string | nulloptional

    Quote this when contacting support.

  • 429

    Rate limit exceeded. See the Retry-After header. Error code: rate_limited.

    Error body fields
    Fields of the 429 error body of Search pages in a wiki
    FieldDescription
    error
    object
    —
    error.code
    string

    A stable, machine-readable error code.

    One of invalid_request, unauthorized, insufficient_scope, forbidden, not_found, conflict, rate_limited, internal_error.

    error.message
    string

    A description for people. The wording may change.

    error.details
    object[]optional

    For invalid_request: the fields that failed validation.

    error.details[].field
    stringoptional
    —
    error.details[].message
    stringoptional
    —
    error.request_id
    string | nulloptional

    Quote this when contacting support.

Any request can also fail with 500 internal_error. See Errors for every code.

Example

Request
curl "https://api.slimwiki.com/v1/wikis/6f1c2d0e-8a3b-4c5d-9e7f-0a1b2c3d4e5f/pages/search?query=release" \
  -H "Authorization: Bearer $SLIMWIKI_API_KEY"
Response
200 · application/json
{
  "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
}

Previous

List pages in a wiki
GET /v1/wikis/{wiki_id}/pages

Next

Find a page by slug or hash
GET /v1/wikis/{wiki_id}/pages/lookup

SlimWiki Developers

slimwiki.com