> ## Documentation Index
> Fetch the complete documentation index at: https://docs.timbal.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Project

> Get a project by ID.



## OpenAPI

````yaml GET /orgs/{org_id}/projects/{project_id}
openapi: 3.1.0
info:
  title: Timbal Platform API
  description: Public API documentation for the Timbal platform
  license:
    name: ''
  version: 2.0.0
servers:
  - url: https://api.timbal.ai
    description: Production
  - url: https://api.dev.timbal.ai
    description: Development
security: []
tags:
  - name: ace
    description: Action Control Engine (ACE) operations
  - name: alarms
    description: Metric series and threshold alarms
  - name: analytics
    description: Org and project analytics
  - name: billing
    description: Subscriptions, usage, and payment-related operations
  - name: channels
    description: Delivery channels alarms notify through
  - name: content
    description: Re-sign stored content URLs
  - name: files
    description: File operations
  - name: iam
    description: IAM — actions, roles, users, and authorization introspection
  - name: k2
    description: Knowledge Bases v2 operations
  - name: orgs
    description: Organization operations
  - name: projects
    description: Project operations
  - name: runs
    description: Execution operations
  - name: templates
    description: Public project template catalog
  - name: users
    description: Authenticated user profile
paths:
  /orgs/{org_id}/projects/{project_id}:
    get:
      tags:
        - projects
      description: Get a project by ID.
      operationId: handler
      parameters:
        - name: org_id
          in: path
          required: true
          schema:
            type: string
        - name: project_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Project details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectDetail'
        '403':
          description: Insufficient permissions
      security:
        - bearer_auth: []
components:
  schemas:
    ProjectDetail:
      type: object
      required:
        - id
        - name
        - has_ui
        - role
        - use_platform_iam
        - is_public_template
        - template_uses
        - publishable_api_key
        - environments
        - knowledge_bases
        - integrations
        - auth_enabled
        - auth_providers
        - channels
        - created_at
        - updated_at
      properties:
        auth_enabled:
          type: boolean
          description: >-
            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:
          type: array
          items:
            type: string
          description: >-
            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:
          type: array
          items:
            $ref: '#/components/schemas/ProjectChannel'
          description: >-
            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:
          type: integer
          format: int64
          description: Creation timestamp in epoch milliseconds
        default_role:
          type:
            - string
            - 'null'
          description: >-
            Project's default role. All organization members will be assigned
            this role by default for this project
        description:
          type:
            - string
            - 'null'
          description: Project description
        environments:
          type: array
          items:
            $ref: '#/components/schemas/EnvPreview'
          description: Project environments with their latest deployment status
        has_ui:
          type: boolean
          description: Whether the project has a UI interface
        id:
          type: string
          description: Unique project identifier
        integrations:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationPreview'
          description: Integrations active in this project
        is_public_template:
          type: boolean
          description: Whether the project is a public template
        knowledge_bases:
          type: array
          items:
            $ref: '#/components/schemas/KbPreview'
          description: Knowledge bases connected to this project (new KB system only)
        name:
          type: string
          description: Project name
        publishable_api_key:
          type: string
          description: Publishable API key for this project
        repository_url:
          type:
            - string
            - 'null'
          description: >-
            URL of the project's source code repository. When null, the project
            does not have source code available
        role:
          type: string
          description: >-
            **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_url:
          type:
            - string
            - 'null'
          description: >-
            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:
          type:
            - string
            - 'null'
          description: '**Deprecated:** prefer `screenshot_signed_url` when present.'
          deprecated: true
        search_text:
          type:
            - string
            - 'null'
          description: >-
            Text corpus used for semantic similarity matching when recommending
            templates.
        template_description:
          type:
            - string
            - 'null'
          description: >-
            Public-facing description shown when the project is listed as a
            template.
        template_uses:
          type: integer
          format: int64
          description: Number of times this template has been used
        updated_at:
          type: integer
          format: int64
          description: Last update timestamp in epoch milliseconds
        use_platform_iam:
          type: boolean
          description: >-
            Whether the project uses the platform's IAM system for access
            control
    ProjectChannel:
      type: object
      description: |-
        One channel binding as returned on the project payload. Topology only —
        credentials are never included here.
      required:
        - provider
        - workforce
      properties:
        configured:
          type: boolean
          description: Whether credentials for this binding are stored platform-side.
        enabled:
          type: boolean
          description: >-
            Soft toggle from the UI. Omitted/`true` means the channel is on;
            `false`

            keeps the workforce mapping so it can be re-enabled without
            reconfiguring.
        provider:
          type: string
          description: Channel provider id (for example `telegram`, `slack`).
        workforce:
          type: string
          description: |-
            Workforce component the channel talks to — always the component's
            manifest uid on read.
    EnvPreview:
      type: object
      required:
        - id
        - name
        - color
      properties:
        color:
          type: string
          description: Environment color
        id:
          type: string
          description: Environment identifier
        last_deployment_status:
          type:
            - string
            - 'null'
          description: Status of the latest deployment in this environment
        name:
          type: string
          description: Environment name
    IntegrationPreview:
      type: object
      required:
        - id
        - provider
        - name
      properties:
        id:
          type: string
          description: Integration identifier
        logo_url:
          type:
            - string
            - 'null'
          description: Integration logo URL
        name:
          type: string
          description: Integration display name
        provider:
          type: string
          description: Integration provider key
    KbPreview:
      type: object
      required:
        - id
        - uid
        - name
      properties:
        description:
          type:
            - string
            - 'null'
          description: Knowledge base description
        id:
          type: string
          description: Knowledge base identifier
        name:
          type: string
          description: Knowledge base name
        uid:
          type: string
          description: Knowledge base unique identifier
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      description: >-
        Timbal API key. Obtain your API key from the Timbal platform settings.
        See [Authentication](/api-reference/authentication) for more
        information.

````