Files
VRChatBackendDocs/Apis/JamsApi.md
ExilProductions aa707d1deb add subdir
2026-02-15 17:39:26 +01:00

2.2 KiB

JamsApi

All URIs are relative to https://api.vrchat.cloud/api/1

Method HTTP request Description
getJam GET /jams/{jamId} Show jam information
getJamSubmissions GET /jams/{jamId}/submissions Show jam submissions
getJams GET /jams Show jams list

getJam

Jam getJam(jamId)

Show jam information

Returns a jam.

Parameters

Name Type Description Notes
jamId String Must be a valid query ID. [default to null]

Return type

Jam

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getJamSubmissions

List getJamSubmissions(jamId)

Show jam submissions

Returns all submissions of a jam.

Parameters

Name Type Description Notes
jamId String Must be a valid query ID. [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getJams

List getJams(type)

Show jams list

Lists World Jams or Avatar Jams, both currently running and ones that have ended.  `isActive` is used to select only active or already ended jams.  `type` is used to select only world or avatar jams, and can only take `world` or `avatar`. ``

Parameters

Name Type Description Notes
type String Only show jams of this type (`avatar` or `world`). [optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json