This API specification enables external software to easily fetch information about the board, this includes Users and their affiliations (groups, threads, posts), Threads (specific forums, specific author), Groups (members), and more.

Currently there is no rate-limit nor authentication required to access the API, but it is planned that every Software must be authenticated by a private and unique API Key, that must be introduced and authenticated in each headers request in the near future.

This project is still under development, and therefore some endpoints and options might be missing, this specification is used not only as a reference, but also as a plan for upcoming features.

https://forum.jellyfin.org/api/

Authentication might be required for some endpoints, this will be specified when required. The API key is a randomly generated string, that should be included in all requests that requires authentication.

To include the API key in a request, add the API-KEY header to the request containing the API key.

The authentication has it's own endpoint, which can be used to authenticate a specific user. This allows software to authenticate a user by API key instead of Username and Password.

It is up to the external software to lock the usage of their systems to the specific User, this can be done by IP whitelisting, or by implementing a GUID or SID lock and storing the credentials in their own database or storage.

Parameters

GET POSTname Username of the User

API-KEY: 22f29bcb-95bd7a92-f91ce791-82069

https://forum.jellyfin.org/api/users.php

{
    "id": 1,
    "username": "John Doe",
    "avatar": "images/default_avatar.png",
    "usergroup": 4,
    "additionalgroups": [
        "3"
    ],
    "displaygroup": 0,
    "usertitle": "Fantastic Poster",
    "away": false,
    "awayreason": "",
    "referrer": 0,
    "timeonline": 21336,
    "warningpoints": 0
}

The users endpoint can retrieve and search for a user either by their id or by their username. Currently both methods look for an exact match.

Either parameter must exist, and if multiple parameters are given only one will be used after prioritization. (ID = High, Name = Medium)

Parameters

GETid Unique ID of the User

GETname Username of the User

https://forum.jellyfin.org/api/users.php

{
    "id": 1,
    "username": "John Doe",
    "avatar": "images/default_avatar.png",
    "usergroup": 4,
    "additionalgroups": [
        "3"
    ],
    "displaygroup": 0,
    "usertitle": "Fantastic Poster",
    "away": false,
    "awayreason": "",
    "referrer": 0,
    "timeonline": 21336,
    "warningpoints": 0
}

The threads endpoint can be used to retrieve either a specific thread, or a paginated list of threads. Additional option to lookup threads in specific Forums by Forum ID (FID).

For the paginated response (Automatically by not including ID paramter) the amount per page is set to 10 results.

Parameters

GETid Unique ID of the Thread

GETfid Forum ID to lookup

GETpage Page to lookup

https://forum.jellyfin.org/api/threads.php

{
    "id": 8,
    "subject": "Hello World",
    "fid": 2,
    "uid": 1,
    "author": "admin",
    "views": 1,
    "replies": 0,
    "closed": false,
    "sticky": false,
    "createdAt": 1651180770,
    "post": {
        "id": 22,
        "tid": 8,
        "fid": 2,
        "uid": 1,
        "author": "admin",
        "subject": "Hello World",
        "message": "This thread is the first of it's kind! Hello World!"
    }
}

The posts endpoint can be used to retrieve either a specific post, or a paginated list of posts. Additional option to lookup posts in specific Forums by Forum ID (FID) and specific Thread by Thread ID (TID).

In case of multiple included parameters, the most suitable one will be picked, even if it will not have any results. (ID = High, FID = Medium, TID = Low)

For the paginated response (Automatically by not including ID paramter) the amount per page is set to 10 results.

Parameters

GETid Unique ID of the Post

GETfid Forum ID to lookup posts

GETtid Thread ID to lookup posts

GETpage Page to lookup

https://forum.jellyfin.org/api/posts.php

{
    "id": 22,
    "tid": 8,
    "fid": 2,
    "uid": 1,
    "author": "admin",
    "subject": "Hello World",
    "message": "This thread is the first of it's kind! Hello World!"
}