Skip to content
Modrinth Documentation

Get a project

GET
/project/{id|slug}

Parameters

Path Parameters

id|slug
required
string
[
  "AABBCCDD",
  "my_project"
]

The ID or slug of the project

Responses

200

Expected response to a valid request

object
id
required

The ID of the project, encoded as a base62 string

string
AABBCCDD
team
required

The ID of the team that has ownership of this project

string
MMNNOOPP
body_url

The link to the long description of the project. Always null, only kept for legacy compatibility.

string
nullable
moderator_message

A message that a moderator sent regarding the project

object
message

The message that a moderator has left for the project

string
body

The longer body of the message that a moderator has left for the project

string
nullable
published
required

The date the project was published

string format: ISO-8601
updated
required

The date the project was last updated

string format: ISO-8601
approved

The date the project’s status was set to an approved status

string format: ISO-8601
nullable
queued

The date the project’s status was submitted to moderators for review

string format: ISO-8601
nullable
followers
required

The total number of users following the project

integer
license

The license of the project

object
id

The SPDX license ID of a project

string
LGPL-3.0-or-later
name

The long name of a license

string
GNU Lesser General Public License v3 or later
url

The URL to this license

string
nullable
versions

A list of the version IDs of the project (will never be empty unless draft status)

Array<string>
[
  "IIJJKKLL",
  "QQRRSSTT"
]
game_versions

A list of all of the game versions supported by the project

Array<string>
[
  "1.19",
  "1.19.1",
  "1.19.2",
  "1.19.3"
]
loaders

A list of all of the loaders supported by the project

Array<string>
[
  "forge",
  "fabric",
  "quilt"
]
gallery

A list of images that have been uploaded to the project’s gallery

Array<object>
object
url
required

The URL of the gallery image

string
https://cdn.modrinth.com/data/AABBCCDD/images/009b7d8d6e8bf04968a29421117c59b3efe2351a.png
featured
required

Whether the image is featured in the gallery

boolean
true
title

The title of the gallery image

string
nullable 
My awesome screenshot!
description

The description of the gallery image

string
nullable 
This awesome screenshot shows all of the blocks in my mod!
created
required

The date and time the gallery image was created

string format: ISO-8601
ordering

The order of the gallery image. Gallery images are sorted by this field and then alphabetically by title.

integer
0

404

The requested item(s) were not found or no authorization to access the requested item(s)