Skip to main content
GET
cURL

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

Response

Project details

auth_enabled
boolean
required

Master sign-in switch for the deployed app: when false the app is public, when true it requires end-user sign-in via auth_providers.

auth_providers
string[]
required

Enabled end-user sign-in methods for the project's deployed app login screen (for example email, google, microsoft, github). Empty when no sign-in method has been turned on.

channels
object[]
required

Messaging channel topology for the deployed app (provider → workforce). Empty when no channels are connected. Topology and configuration state only; credentials are never included.

created_at
integer<int64>
required

Creation timestamp in epoch milliseconds

environments
object[]
required

Project environments with their latest deployment status

has_ui
boolean
required

Whether the project has a UI interface

id
string
required

Unique project identifier

integrations
object[]
required

Integrations active in this project

is_public_template
boolean
required

Whether the project is a public template

knowledge_bases
object[]
required

Knowledge bases connected to this project (new KB system only)

name
string
required

Project name

publishable_api_key
string
required

Publishable API key for this project

role
string
required

Deprecated — will be removed. Always "admin" for backwards-compatible response shape. Caller permissions are determined by v2 IAM grants, not this field. Use /orgs/{org_id}/iam/check or effective-grants instead.

template_uses
integer<int64>
required

Number of times this template has been used

updated_at
integer<int64>
required

Last update timestamp in epoch milliseconds

use_platform_iam
boolean
required

Whether the project uses the platform's IAM system for access control

default_role
string | null

Project's default role. All organization members will be assigned this role by default for this project

description
string | null

Project description

repository_url
string | null

URL of the project's source code repository. When null, the project does not have source code available

screenshot_signed_url
string | null

CloudFront-signed screenshot URL, minted per response (TTL-bound). Present only when the banner is a Timbal-hosted screenshot (private orgs/{}/projects/{}/screenshots/* prefix) and signing is configured.

NOTE: screenshots live under a private prefix, so this URL is signed and short-lived. If a banner ever needs to live on a public / cacheable surface (timbal.ai landing pages, OG/meta image tags, emails — anywhere the URL is cached or can't be re-minted per request), copy the object to a public prefix (e.g. orgs/{org_id}/assets/...) and serve that unsigned instead of signing this one.

screenshot_url
string | null
deprecated

Deprecated: prefer screenshot_signed_url when present.

search_text
string | null

Text corpus used for semantic similarity matching when recommending templates.

template_description
string | null

Public-facing description shown when the project is listed as a template.