v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01206322659.2 KB
projects

Get a project by ID.

get/orgs/{org_id}/projects/{project_id}

Path parameters

org_idstring required
project_idstring required

Response

Project details

auth_enabledboolean 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_providersstring[] 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.

created_atinteger required

Creation timestamp in epoch milliseconds

default_rolestring nullable

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

descriptionstring nullable

Project description

has_uiboolean required

Whether the project has a UI interface

idstring required

Unique project identifier

is_public_templateboolean required

Whether the project is a public template

namestring required

Project name

publishable_api_keystring required

Publishable API key for this project

repository_urlstring nullable

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

rolestring 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.

screenshot_signed_urlstring nullable

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_urlstring nullable

Deprecated: prefer screenshot_signed_url when present.

search_textstring nullable

Text corpus used for semantic similarity matching when recommending templates.

template_descriptionstring nullable

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

template_usesinteger required

Number of times this template has been used

updated_atinteger required

Last update timestamp in epoch milliseconds

use_platform_iamboolean required

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