Skip to main content
GET
List releases

Authorizations

Authorization
string
header
required

Send your API token as Authorization: Bearer <api-token>.

Path Parameters

project_id
string
required

The app's name.

Query Parameters

teamID
string

Run the request in the context of a team you belong to, instead of your personal account. 24-character hexadecimal ID.

Pattern: ^[0-9a-fA-F]{24}$
page
integer
default:1

Page number, starting at 1.

Required range: x >= 1
count
integer
default:10

Releases per page.

Required range: 1 <= x <= 20
sort
enum<string>
default:DESC
Available options:
DESC,
ASC
state
enum<string>

Send PENDING to list only releases waiting to be built.

Available options:
PENDING

Response

The app's releases. The response can include additional fields not listed here.

total
integer

Total number of releases.

currentRelease
string | null

ID of the release that's running now.

readyReleasesCount
integer
platform
enum<string>

The app's platform.

Available options:
node,
next,
react,
vue,
angular,
static,
laravel,
php,
django,
flask,
python,
netcore,
dotnet,
go,
docker
releases
object[]