Branches - List branches
Route URL
GET https://playcanvas.com/api/projects/:projectId/branches
Description
Get a list of all open branches for a project
Example
curl -H "Authorization: Bearer {accessToken}" "https://playcanvas.com/api/projects/{projectId}/branches"
HTTP Request
GET https://playcanvas.com/api/projects/{projectId}/branches
Authorization: Bearer {accessToken}
Parameters
projectId: number
The id of the project to list branches from
Response Schema
Status: 200
{
"result": [ {
"id": string,
"projectId": int,
"name": "Branch Name",
"createdAt": data,
"closed": bool,
"latestCheckpointId": string,
"user": {
"id": int,
"fullName": string,
"username": string
}
},, ...],
"pagination": {
"hasMore": bool
}
}
This endpoint uses a slightly different pagination method. If a response contains the value hasMore: true
then additional results
are available. Use ?skip=branchId
query parameter with the last received branch id to receive more branches in alphabetical order.
Errors
401
Unauthorized
403
Forbidden
404
Project not found
429
Too many requests
Rate Limiting
This route uses a normal rate limit.