Skip to main content

Projects - Get project

Route URL

GET https://playcanvas.com/api/projects/:projectId

Description

Get the details of a single project.

Example

curl -H "Authorization: Bearer {accessToken}" https://playcanvas.com/api/projects/{projectId}

Parameters

NameTypeRequiredDefaultDescription
projectIdnumber✔️The id of the project.

Response Schema

Status: 200
{
"id": int,
"name": string,
"description": string,
"created": date,
"modified": date,
"owner": string,
"owner_id": int,
"access_level": string,
"fork_count": int,
"locked": bool,
"new_owner": string|null,
"permissions": {
"admin": [string],
"write": [string],
"read": [string]
},
"plays": int,
"primary_app": int,
"primary_app_url": string,
"private": bool,
"size": {
"total": int,
"code": int,
"apps": int,
"assets": int,
"checkpoints": int
},
"starred": int,
"thumbnails": {
"s": string,
"m": string,
"l": string,
"xl": string
},
"views": int
}

Errors

CodeDescription
401Unauthorized
403Forbidden
404Project not found
429Too many requests

Rate Limiting

This route uses a normal rate limit.