FaxDocs API

From FaxDocs version 2.4.0 the v2 API is supported. This API is the updated version and the v1 API is no longer documented publicly.

GET /api/v2/search

Search for a page within FaxDocs. Only non hidden pages are displayed in results.

Parameters

Result Array Example

[
  {
    "id": 4,
    "creatorId": "282762192544333827",
    "creatorName": "FAXES",
    "creatorIcon": "/images/user-282762192544333827.png",
    "title": "Link One",
    "shortLink": "link-one",
    "description": "This is an article.",
    "catId": 1,
    "pos": 200,
    "createdAt": "1654165296182",
    "deleted": 0,
    "updated": "1701923282782",
    "subcat": 0,
    "subcatId": 0,
    "requiredRoles": "",
    "recommended": 2,
    "keywords": "",
    "related": "",
    "markdown": "<p class="convertPara">This is an article.</p>",
    "plainText": "This is an article."
  }
]

GET /api/v2/articles

Returns an array of all articles within the site.

[
  {
    "id": 1,
    "creatorId": "282762192544333827",
    "creatorName": "FAXES",
    "creatorIcon": "/images/example.png",
    "title": "Article One",
    "shortLink": " artone",
    "description": "Article One",
    "catId": 1,
    "pos": 10,
    "createdAt": "1650961502009",
    "deleted": 0,
    "updated": null,
    "subcat": 1,
    "subcatId": 0,
    "requiredRoles": "",
    "recommended": 0,
    "keywords": null,
    "related": null,
    "markdown": "<p class="convertPara">Article One</p>",
    "plainText": "
Article One "
  }
]

GET /api/v2/categories

Returns an array of all categories on the website.

[
  {
    "id": 1,
    "name": "Cat One",
    "shortLink": "one",
    "description": "This is category one.",
    "image": "/images/example.png",
    "pos": 10,
    "deleted": 0,
    "markdown": "",
    "plainText": ""
  },
  {
    "id": 2,
    "name": "Cat Two",
    "shortLink": "two",
    "description": "This is category two.",
    "image": "/images/example.png",
    "pos": 1,
    "deleted": 0,
    "markdown": "",
    "plainText": ""
  }
]