Version: Loading...
Last Updated: Loading...

Notice:

The public api is still experimental!
If you see ! that means it is not yet implemented.

Most of our Parameters are used through URL params, not headers or body.
However, this does not include the authorization parameter, which can be sent through either a header or URL param.

Get started

    Default API Link

        https://api.jailbreakchangelogs.xyz/

The Jailbreak Changelogs API allows developers and users to access information about Jailbreak, such as changelogs, seasons, and comments from our website.

To use our API, you will need to generate an API key at: https://jailbreakchangelogs.xyz/keys. Please note that you must set the permissions you require.

Violations of our API/TOS will result in blacklisting from this API and the deletion of your API key(s). This includes excessive requests and using our data for your own information services that we already provide, such as a Discord bot or website.

If you have any questions, concerns, or need help, please don't hesitate to reach out to us at [email protected].

Items

Changelog Item

                
Json example of a Changelog item:

                
{
    "id": 2,
    "title": "April 29th 2017 / SUPER  CAR UPDATE",
    "sections": "- New vehicle: La Matador  \n- Jumping out of a helicopter now deploys a parachute  \n- New game pass: VIP Game Pass  \n- Volcano Criminal Base added  \n- Added a Prison Jumpsuit Rack in both criminal bases to allow criminals to remove their Prison Jumpsuit  \n- Other bug fixes & improvements\n",
    "image_url": "https://cdn.jailbreakchangelogs.xyz/images/changelogs/2.webp"
}
Field Type Description
ID Integer The specified changelog ID.
Title String Title of the requested changelog.
Sections String Formatted loosely in markdown, a list of fields for a changelog.
Image URL String The image associated with the changelog.

Season Item

                
Json example of a Season item:

                
{
    "season": 22,
    "title": "Visiting America",
    "description": "The theme of the season is called \"Visiting America\" (initially \"Season 22: Made in America\"), which is featuring prizes themed around the United States of America. The season began on June 21, 2024 and ended on September 17, 2024, and lasted for 87 days. This makes it the longest contract-based season."
}
Field Type Description
Season Integer The specified season number.
Title String Title of the requested season.
Description String Description of the requested season.

Reward Item

                
Json example of a Reward item:

                
{
    "id": 247,
    "season_number": 22,
    "item": "Fabulous Wall Furniture",
    "requirement": "Level 2",
    "link": "https://cdn.jailbreakchangelogs.xyz/images/seasons/22/2.webp",
    "exclusive": "False",
    "bonus": "False"
}
Field Type Description
ID Integer The reward ID, NOT the level for the reward.
Season Number Integer Season to which the reward belongs.
Item String The reward's item.
Requirement String The requirement for the reward.
Link String The image of the reward.
Exclusive Boolean Whether the item is a season pass item or not.
Bonus Boolean Whether the item is a bonus item or not.

Comment Item

                
Json example of a Comment item:

                
{
    "id": 41,
    "user_id": "659865209741246514",
    "content": "1",
    "date": 1727736732,
    "item_id": 23,
    "item_type": "season"
}
Field Type Description
ID Integer The comment ID.
User ID Integer The author of the comment, Discord user ID.
Content String The content of the comment.
Date Integer The unix timestamp the comment was posted.
Item ID Integer The ID this comment belongs to, such as season "13".
Item Type String The type of comment this is, such as changelog or season.
Edited At Integer The unix timestamp of the edited comment, null if none.

Follower Item

                
Json example of a Follower:

                
{
    "follower_id": "1019539798383398946",
    "created_at": 1731255076
}
Field Type Description
Follower ID Integer The followers User ID.
Created At Integer The unix timestamp the user followed the requested person.

Followed Item

                
Json example of a Followed user:

                
{
    "followed_id": "1019539798383398946",
    "created_at": 1728205706
}
Field Type Description
Followed ID Integer The followed user's ID.
Created At Integer The unix timestamp the requested person followed the user.

User Item

                
Json example of a User

                
{
    "id": "659865209741246514",
    "username": "jakobiis",
    "avatar": "556833499d1f3f7cc3cc0d9eca75df7c",
    "banner": null,
    "accent_color": 2959918,
    "global_name": "Jakobiis",
    "locale": "en-US"
}
Field Type Description
ID String The unique identifier of the user.
Username String The username of the user.
Avatar String The hash of the user's avatar image.
Banner String or Null The banner of the user, if available.
Global Name String The global display name of the user.
Locale String The user's locale (e.g., language and region).

Settings

                
Json example of Settings

                
{
    "user_id": "1019539798383398946",
    "profile_public": 1,
    "show_recent_comments": 1,
    "hide_following": 1,
    "hide_followers": 1,
    "banner_discord": 1,
    "updated_at": 1729626069
}
Field Type Description
User ID String The unique identifier of the user.
Profile Public Integer Indicates if the user's profile is public (1) or private (0).
Show Recent Comments Integer Indicates if recent comments are shown (1) or hidden (0).
Hide Following Integer Indicates if the user's following list is hidden (1) or visible (0).
Hide Followers Integer Indicates if the user's followers list is hidden (1) or visible (0).
Updated At Integer The timestamp of when the user's profile was last updated.

Description Item

                
Json example of a Description

                
{
    "description": "this is truly amazing",
    "last_updated": 1728216068
}
Field Type Description
Description String The description of the user (may have newlines).
Last Updated Integer Unix timestamp for when the description was updated.

changelogs

      
Example request | fetching changelog #1:

                            
curl -X GET "https://api.jailbreakchangelogs.xyz/changelogs/get?id=1" \
-H "Authorization: YOUR_API_KEY"

This will return a Changelog item
                
      
Example request | fetching all changelogs:

                            
curl -X GET "https://api.jailbreakchangelogs.xyz/changelogs/list" \
-H "Authorization: YOUR_API_KEY"

This will return a list of Changelog items



                
      
Example request | fetching latest changelog:

                            
curl -X GET "https://api.jailbreakchangelogs.xyz/changelogs/latest" \
-H "Authorization: YOUR_API_KEY"

This will return a Changelog item

There are three changelog endpoints:

/changelogs/get

Field Type Description
Authorization String Your API key.
ID Integer The Changelog you are requesting.

/changelogs/list

Field Type Description
Authorization String Your API key.
! Limit Integer The Limit of Changelogs to fetch.

/changelogs/latest

Field Type Description
Authorization String Your API key.


seasons

      
Example request | fetching season 13:

                            
curl -X GET "https://api.jailbreakchangelogs.xyz/seasons/get?season=13" \
-H "Authorization: YOUR_API_KEY"

This will return a Season item
                
      
Example request | fetching all seasons:

                            
curl -X GET "https://api.jailbreakchangelogs.xyz/seasons/list" \
-H "Authorization: YOUR_API_KEY"

This will return a list of Season items



                
        
Example request | fetching latest season:

                            
curl -X GET "https://api.jailbreakchangelogs.xyz/seasons/latest" \
-H "Authorization: YOUR_API_KEY"

This will return a Season item

There are two season endpoints:

/seasons/get

Field Type Description
Authorization String Your API key.
Season Integer The Season you are requesting.

/seasons/list

Field Type Description
Authorization String Your API key.
! Limit Integer The Limit of Seasons to fetch.

/seasons/latest

Field Type Description
Authorization String Your API key.


Rewards

      
Example request | fetching rewards for season 16:

                            
curl -X GET "https://api.jailbreakchangelogs.xyz/rewards/get?season=16" \
-H "Authorization: YOUR_API_KEY"

This will return a Reward item
                
      
Example request | fetching all rewards:

                            
curl -X GET "https://api.jailbreakchangelogs.xyz/rewards/list" \
-H "Authorization: YOUR_API_KEY"

This will return a list of Reward items

There are two reward endpoints:

/rewards/get

Field Type Description
Authorization String Your API key.
Season Integer The Seasons Rewards you are fetching.

/rewards/list

Field Type Description
Authorization String Your API key.
! Limit Integer The Limit of Seasons to fetch.


Comments

      
Example request | fetching comments for season 16:

                            
curl -X GET "https://api.jailbreakchangelogs.xyz/comments/get?type=season&id=16" \
-H "Authorization: YOUR_API_KEY"

This will return a list of Comment items
                
      
Example request | fetching comments for changelogs:

                            
curl -X GET "https://api.jailbreakchangelogs.xyz/comments/get?type=changelog" \
-H "Authorization: YOUR_API_KEY"

This will return a list of Comment items
                
      
Example request | fetching comment:

                            
curl -X GET "https://api.jailbreakchangelogs.xyz/comments/get?id=1" \
-H "Authorization: YOUR_API_KEY"

This will return a Comment item
                
      
Example request | fetching comments by user:

                            
curl -X GET "https://api.jailbreakchangelogs.xyz/comments/get/user?author=659865209741246514" \
-H "Authorization: YOUR_API_KEY"

This will return a list of Comment items

There are two comments endpoints:

/comments/get

Field Type Description
Authorization String Your API key.
(Optional) Item ID Integer The Changelog, Season, or Comment ID.
(Optional) Item Type String The type of item to fetch, such as changelog or season, blank will fetch the comment by ID

/comments/get/user

Field Type Description
Authorization String Your API key.
User ID Integer The user ID of the comment author. (Discord)
! Limit Integer The Limit of Comments to fetch.


Users

                            
Example request | fetching user:

                            
curl -X GET "https://api.jailbreakchangelogs.xyz/users/get?id=659865209741246514" \
-H "Authorization: YOUR_API_KEY"      
                            
This will return a User 
                
                            
Example request | fetching user by partial name:

                            
curl -X GET "https://api.jailbreakchangelogs.xyz/users/get/name?name=jakobiis" \
# Name can be partial
-H "Authorization: YOUR_API_KEY"      
                            
This will return a User 
                
                            
Example request | fetching users settings:

                            
curl -X GET "https://api.jailbreakchangelogs.xyz/users/settings?user=659865209741246514" \
-H "Authorization: YOUR_API_KEY"      
                            
This will return a Settings item
                
                    
Example request | fetching users followers:

                    
curl -X GET "https://api.jailbreakchangelogs.xyz/users/followers/get?user=659865209741246514" \
-H "Authorization: YOUR_API_KEY"      
                    
This will return a list of Followers
        
            
Example request | fetching users following:

            
curl -X GET "https://api.jailbreakchangelogs.xyz/users/following/get?user=659865209741246514" \
-H "Authorization: YOUR_API_KEY"      
            
This will return a list of Followed users
        
            
Example request | fetching users description:

            
curl -X GET "https://api.jailbreakchangelogs.xyz/users/description/get?user=659865209741246514" \
-H "Authorization: YOUR_API_KEY"      
            
This will return a Description item

There are multiple user endpoints:

/users/get

Field Type Description
Authorization String Your API key.
User ID Integer The ID of the user to fetch. (Discord)

/users/get/name

Field Type Description
Authorization String Your API key.
Name String The Partial name of the (Discord) user to fetch.

/users/settings

Field Type Description
Authorization String Your API key.
User Integer The ID of the (Discord) user's settings to fetch.

/users/followers/get

Field Type Description
Authorization String Your API key.
User Integer The ID of the user to fetch. (Discord)

/users/following/get

Field Type Description
Authorization String Your API key.
User Integer The ID of the user to fetch. (Discord)

/users/description/get

Field Type Description
Authorization String Your API key.
User Integer The ID of the (Discord) user's description to fetch.

Items

                            
Example request | fetching item:

                            
curl -X GET "https://api.jailbreakchangelogs.xyz/items/get?name=torpedo&type=vehicle" \
-H "Authorization: YOUR_API_KEY"      
                            
This will return an Items 
                
                            
Example request | listing all items:

                            
curl -X GET "https://api.jailbreakchangelogs.xyz/items/list" \
-H "Authorization: YOUR_API_KEY"      
                            
This will return a list of Items

There are two item endpoints:

/items/get

Field Type Description
Authorization String Your API key.
Item Name Text The name of the item
(Optional) Item Type Text The name of the item

/items/list

Field Type Description
Authorization String Your API key.