Sign in
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

Changes

Changed in 10 of the 51 revisions of this API.15620

  • 33e77c7fd1131See the full diff
    • ○

      added the required property channels to the response with the 200 status

      response-required-property-added

  • e1c81d0f42356See the full diff
    • ○

      added the optional property screenshot_signed_url to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property search_text to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property template_description to the response with the 200 status

      response-optional-property-added

    • ○

      response property screenshot_url deprecated

      response-property-deprecated

    • ○

      added the required property auth_enabled to the response with the 200 status

      response-required-property-added

    • ○

      added the required property auth_providers to the response with the 200 status

      response-required-property-added

    This revision also has 22 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 45de91fcec331See the full diff
    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 63b3777893c71See the full diff
    • ▲

      removed the required property workforce from the response with the 200 status

      response-required-property-removed

  • 2da1655ba7061See the full diff
    • ○

      added the optional property workforce/items/deleted_at to the response with the 200 status

      response-optional-property-added

  • 62bed9af160c1See the full diff
    • ○

      added the optional property workforce/items/url to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 03807319958f1See the full diff
    • ●

      added the new unknown enum value to the workforce/items/type response property for the response status 200

      response-property-enum-value-added

  • f0c5860bb28a13See the full diff
    • ▲

      removed the required property apps from the response with the 200 status

      response-required-property-removed

    • ○

      added the required property environments to the response with the 200 status

      response-required-property-added

    • ○

      added the required property integrations to the response with the 200 status

      response-required-property-added

    • ○

      added the required property knowledge_bases to the response with the 200 status

      response-required-property-added

  • 931f6fb750bb423See the full diff
    • ▲

      the apps/items/id response's property type/format changed from integer/int64 to string/ for status 200

      response-property-type-changed

    • ▲

      the created_at response's property type/format changed from string/date-time to integer/int64 for status 200

      response-property-type-changed

    • ▲

      the id response's property type/format changed from integer/int64 to string/ for status 200

      response-property-type-changed

    • ▲

      the updated_at response's property type/format changed from string/date-time to integer/int64 for status 200

      response-property-type-changed

    • ●

      removed the optional property apps/items/unversioned_source_updated_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property interface_unversioned_source_updated_at from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property apps/items/uid to the response with the 200 status

      response-optional-property-added

    • ○

      response property apps deprecated

      response-property-deprecated

    • ○

      added the required property workforce to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • eb2c08128881934See the full diff
    • ▲

      the created_at response's property type/format changed from integer/int64 to string/date-time for status 200

      response-property-type-changed

    • ▲

      the id response's property type/format changed from string/ to integer/int64 for status 200

      response-property-type-changed

    • ▲

      the updated_at response's property type/format changed from integer/int64 to string/date-time for status 200

      response-property-type-changed

    • ▲

      removed the required property auth_enabled from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property auth_providers from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property channels from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property environments from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property integrations from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property knowledge_bases from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property screenshot_signed_url from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property search_text from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property template_description from the response with the 200 status

      response-optional-property-removed

    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

    • ○

      added the optional property interface_unversioned_source_updated_at to the response with the 200 status

      response-optional-property-added

    • ○

      response property screenshot_url reactivated

      response-property-reactivated

    • ○

      added the required property apps to the response with the 200 status

      response-required-property-added

    This revision also has 238 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog