Skip to main content
GET
/
orgs
/
{org_id}
/
projects
/
{project_id}
/
envs
/
{env_id}
/
deployments
cURL
curl --request GET \
  --url https://api.timbal.ai/orgs/{org_id}/projects/{project_id}/envs/{env_id}/deployments \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.timbal.ai/orgs/{org_id}/projects/{project_id}/envs/{env_id}/deployments"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.timbal.ai/orgs/{org_id}/projects/{project_id}/envs/{env_id}/deployments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.timbal.ai/orgs/{org_id}/projects/{project_id}/envs/{env_id}/deployments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.timbal.ai/orgs/{org_id}/projects/{project_id}/envs/{env_id}/deployments"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.timbal.ai/orgs/{org_id}/projects/{project_id}/envs/{env_id}/deployments")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.timbal.ai/orgs/{org_id}/projects/{project_id}/envs/{env_id}/deployments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "deployments": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "id": 123,
      "project_env_id": 123,
      "status": "<string>",
      "target": {
        "id": 123,
        "type": "<string>",
        "commit": "<unknown>",
        "manifest_id": "<string>"
      },
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "build_finished_at": "2023-11-07T05:31:56Z",
      "build_logs": "<string>",
      "build_started_at": "2023-11-07T05:31:56Z",
      "cpu": 123,
      "desired_count": 123,
      "domain": "<string>",
      "ephemeral_storage": 123,
      "memory": 123,
      "status_detail": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

org_id
string
required
project_id
string
required
env_id
string
required

Query Parameters

component_id
string | null

Filter to a single workforce component by its numeric app id (the value the SDK reads from TIMBAL_APP_ID, also returned as id on each deployment in the response). Combines with component_uid: when both are set, rows must match both.

component_uid
string | null

Filter to a single workforce component by its manifest uid (the _id field in timbal.yaml, also returned as uid on each deployment in the response). Display name is deliberately not accepted as a filter — it's user-editable and not guaranteed unique within a project.

status
string | null
trigger
string | null

Optional trigger filter. Accepts:

  • latest — return every row sharing the most recent trigger for this env; falls back to the latest row per component when the env has no trigger history.
  • a UUID — return every row produced by that trigger.

Response

Deployments listed successfully

deployments
object[]
required