REST API Documentation

kpdiggs

Is there any documentation of the REST API Beyond the documentation here:
https://docs.flarum.org/rest-api/

This only contains 4 endpoints, token, list discussion, create discussion, and create user. It also has no definition of any parameters.

I know there are parameters because I see them being sent when I use the network tab in the browser and I see many more endpoints than those 4.

I see the documentation for the "API" but that seems to be the entire class base of the PHP and Javascript code. This is not what I am looking for. I'm looking for something like a Swagger doc just letting me know what endpoints are exposed and what the parameters are that I can send to them.

Thanks!

kpdiggs

I'm still trying to find any bit of documentation on the REST API. Any clue as to where to look would be greatly appreciated.

I've traced calls using the network tab in the browser and am now using the /posts and /discussions calls to pull some information, but it is all just guesswork.

I see filters like &filter[likedBy]=1 for pulling likes by user id. What other filters are available? I see &include but have no idea what can be included. I see sorting but what are all the options I can sort by.

There has to be something I'm missing. This has to be documented somewhere, right?

bernard445

Yeah, the REST API docs are pretty bare bones right now. most of the extra endpoints can only be figured out by watching the network calls in flarum itself or digging into the code. would be nice if the docs got expanded a bit.

KBExit

bernard445 I was able to get user registration and automated posts configured using the API documentation with n8n 👌

Edit I misunderstood. My bad. Lol