Basic Downloads
FaxDesk
FaxDocs
FaxUp
FaxTrack
WebForms
WLink
Bot Portfolio
Discord Whitelist
Markdown Guide
Weblutions Documentation > Product Documentation > FaxDocs > FaxDocs API
FaxDocs API
FaxDocs comes shipped with an API which can be used. From version 2.4.0
and up a V2 API is supported, this API version is the most up to date and is documented below.
GET /api/v2/search
Searches for articles that have the title or description matching the search query and returns an array of matched items.
Parameters:
q | [Query] the search term to look up. |
Response: [Expand]
[
{
"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."
}
]
The above method also supports query
instead of q
for the search term.
GET /api/v2/articles
Returns all articles in an array.
Response: [Expand]
[
{
"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 all categories in an array.
Response: [Expand]
[
{
"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": ""
}
]
Review this page
fs api api
1 recommend this page