---
title: "Get project"
method: GET
path: "/api/v1/projects/{projectUuid}"
tags: ["Projects"]
---

# Get project

`GET /api/v1/projects/{projectUuid}`

Get a project of an organiztion

## Path parameters

- `projectUuid` string, required

## Response `200`

Success

- ApiProjectResponse
  - `results` Project, required
    - `provisioningSource` string, nullable
    - `expiresAt` string, date-time, nullable, required
    - `colorPaletteUuid` string, nullable, required
    - `projectDefaults` ProjectDefaults — Project-wide default settings that can be overridden at explore or field level
      - `granularity_labels` RecordStringString — Construct a type with a set of properties K of type T
      - `additional_time_intervals` object — Extra time intervals appended to the built-in defaults for date/timestamp dimensions that do not declare their own `time_intervals`. Values may be standard granularities (e.g. `hour`) or `custom_granularities` keys.
        - `timestamp` union[]
          - union
            - 'RAW' | 'YEAR' | 'QUARTER' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND' | 'MILLISECOND' | 'DAY_OF_WEEK_INDEX' | 'DAY_OF_MONTH_NUM' | 'DAY_OF_YEAR_NUM' | 'WEEK_NUM' | 'MONTH_NUM' | 'QUARTER_NUM' | 'YEAR_NUM' | 'DAY_OF_WEEK_NAME' | 'MONTH_NAME' | 'QUARTER_NAME' | 'HOUR_OF_DAY_NUM' | 'MINUTE_OF_HOUR_NUM'
            - string
        - `date` union[]
          - union
            - 'RAW' | 'YEAR' | 'QUARTER' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND' | 'MILLISECOND' | 'DAY_OF_WEEK_INDEX' | 'DAY_OF_MONTH_NUM' | 'DAY_OF_YEAR_NUM' | 'WEEK_NUM' | 'MONTH_NUM' | 'QUARTER_NUM' | 'YEAR_NUM' | 'DAY_OF_WEEK_NAME' | 'MONTH_NAME' | 'QUARTER_NAME' | 'HOUR_OF_DAY_NUM' | 'MINUTE_OF_HOUR_NUM'
            - string
      - `column_totals` boolean — Default behavior for column totals in results tables. When false, the extra warehouse query that calculates column totals is not run by default for new queries. Charts that explicitly enable "Show column totals" still calculate them. Defaults to true if not specified.
      - `case_sensitive` boolean — Default case sensitivity for string filters across the project. When false, all string filters will be case insensitive by default. Can be overridden at explore or field level. Defaults to true if not specified.
    - `hasDefaultUserSpaces` boolean, required
    - `organizationWarehouseCredentialsUuid` string
    - `createdByUserUuid` string, nullable, required
    - `schedulerFailureContactOverride` string, nullable, required
    - `schedulerFailureIncludeContact` boolean, required
    - `schedulerFailureNotifyRecipients` boolean, required
    - `useProjectTimezoneInFilters` boolean, required
    - `queryTimezone` string, nullable, required
    - `schedulerTimezone` string, required
    - `dbtVersion` union, required
      - 'v1.4' | 'v1.5' | 'v1.6' | 'v1.7' | 'v1.8' | 'v1.9' | 'v1.10' | 'v1.11' | 'v1.12'
      - 'latest'
    - `upstreamProjectUuid` string
    - `pinnedListUuid` string
    - `warehouseConnection` union
      - SnowflakeCredentials — From T, pick a set of properties whose keys are in the union K
        - `type` 'snowflake', required
        - `account` string, required
        - `requireUserCredentials` boolean
        - `authenticationType` 'password' | 'private_key' | 'sso' | 'external_browser' | 'oauth_authorization_code' | 'none'
        - `role` string
        - `database` string, required
        - `warehouse` string, required
        - `schema` string, required
        - `threads` number, double
        - `clientSessionKeepAlive` boolean
        - `queryTag` string
        - `accessUrl` string
        - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
        - `dataTimezone` string
        - `quotedIdentifiersIgnoreCase` boolean
        - `disableTimestampConversion` boolean
        - `timeoutSeconds` number, double
        - `override` boolean
        - `organizationWarehouseCredentialsUuid` string
      - RedshiftCredentials — From T, pick a set of properties whose keys are in the union K
        - `type` 'redshift', required
        - `requireUserCredentials` boolean
        - `authenticationType` 'password' | 'iam' | 'iam_browser'
        - `schema` string, required
        - `threads` number, double
        - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
        - `dataTimezone` string
        - `timeoutSeconds` number, double
        - `useSshTunnel` boolean
        - `sshTunnelHost` string
        - `sshTunnelPort` number, double
        - `sshTunnelUser` string
        - `sshTunnelPublicKey` string
        - `host` string, required
        - `port` number, double, required
        - `dbname` string, required
        - `keepalivesIdle` number, double
        - `sslmode` string
        - `ra3Node` boolean
        - `region` string
        - `isServerless` boolean
        - `clusterIdentifier` string
        - `workgroupName` string
        - `autoCreate` boolean
        - `dbGroups` string[]
        - `assumeRoleArn` string
        - `assumeRoleExternalId` string
        - `awsSsoStartUrl` string
        - `awsSsoRegion` string
        - `awsSsoAccountId` string
        - `awsSsoRoleName` string
      - PostgresCredentials — From T, pick a set of properties whose keys are in the union K
        - `type` 'postgres', required
        - `requireUserCredentials` boolean
        - `role` string
        - `schema` string, required
        - `threads` number, double
        - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
        - `dataTimezone` string
        - `timeoutSeconds` number, double
        - `useSshTunnel` boolean
        - `sshTunnelHost` string
        - `sshTunnelPort` number, double
        - `sshTunnelUser` string
        - `sshTunnelPublicKey` string
        - `host` string, required
        - `port` number, double, required
        - `dbname` string, required
        - `keepalivesIdle` number, double
        - `sslmode` string
        - `sslcertFileName` string
        - `sslkeyFileName` string
        - `sslrootcertFileName` string
        - `searchPath` string
      - BigqueryCredentials — From T, pick a set of properties whose keys are in the union K
        - `type` 'bigquery', required
        - `requireUserCredentials` boolean
        - `authenticationType` 'sso' | 'private_key' | 'adc'
        - `threads` number, double
        - `accessUrl` string
        - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
        - `dataTimezone` string
        - `timeoutSeconds` number, double
        - `project` string, required
        - `dataset` string, required
        - `priority` 'interactive' | 'batch'
        - `retries` number, double
        - `location` string
        - `maximumBytesBilled` number, double
        - `executionProject` string
      - DatabricksCredentials — From T, pick a set of properties whose keys are in the union K
        - `type` 'databricks', required
        - `catalog` string
        - `requireUserCredentials` boolean
        - `authenticationType` 'personal_access_token' | 'oauth_m2m' | 'oauth_u2m'
        - `database` string, required
        - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
        - `dataTimezone` string
        - `serverHostName` string, required
        - `httpPath` string, required
        - `compute` object[]
          - `httpPath` string, required
          - `name` string, required
      - TrinoCredentials — From T, pick a set of properties whose keys are in the union K
        - `type` 'trino', required
        - `requireUserCredentials` boolean
        - `schema` string, required
        - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
        - `dataTimezone` string
        - `host` string, required
        - `port` number, double, required
        - `dbname` string, required
        - `http_scheme` string, required
        - `source` string
      - ClickhouseCredentials — From T, pick a set of properties whose keys are in the union K
        - `type` 'clickhouse', required
        - `requireUserCredentials` boolean
        - `schema` string, required
        - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
        - `dataTimezone` string
        - `timeoutSeconds` number, double
        - `host` string, required
        - `port` number, double, required
        - `secure` boolean
      - AthenaCredentials — From T, pick a set of properties whose keys are in the union K
        - `type` 'athena', required
        - `requireUserCredentials` boolean
        - `authenticationType` 'access_key' | 'iam_role'
        - `database` string, required
        - `schema` string, required
        - `threads` number, double
        - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
        - `dataTimezone` string
        - `region` string, required
        - `assumeRoleArn` string
        - `assumeRoleExternalId` string
        - `s3StagingDir` string, required
        - `s3DataDir` string
        - `workGroup` string
        - `numRetries` number, double
      - union
        - DuckdbMotherduckCredentials — From T, pick a set of properties whose keys are in the union K
          - `type` 'duckdb', required
          - `requireUserCredentials` boolean
          - `database` string, required
          - `schema` string, required
          - `threads` number, double
          - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
          - `dataTimezone` string
          - `connectionType` 'motherduck', required
        - DuckdbDucklakeCredentials — From T, pick a set of properties whose keys are in the union K
          - `type` 'duckdb', required
          - `requireUserCredentials` boolean
          - `schema` string, required
          - `threads` number, double
          - `startOfWeek` 0 | 1 | 2 | 3 | 4 | 5 | 6
          - `dataTimezone` string
          - `connectionType` 'ducklake', required
          - `catalogAlias` string
          - `dataPath` union, required
            - DucklakeDataPathS3 — From T, pick a set of properties whose keys are in the union K
              - …
            - DucklakeDataPathGcs — From T, pick a set of properties whose keys are in the union K
              - …
            - DucklakeDataPathAzure — From T, pick a set of properties whose keys are in the union K
              - …
            - DucklakeDataPathLocal
              - …
          - `catalog` union, required
            - DucklakeCatalogPostgres — From T, pick a set of properties whose keys are in the union K
              - …
            - DucklakeCatalogSqlite
              - …
            - DucklakeCatalogDuckdb
              - …
        - DuckdbEmbeddedCredentials
          - `schema` string
          - `startOfWeek` number, double
          - `dataTimezone` string
          - `requireUserCredentials` boolean
          - `dataset` string, required
          - `connectionType` 'embedded', required
          - `type` 'duckdb', required
    - `dbtConnection` union, required
      - DbtLocalProjectConfig
        - `type` 'dbt', required
        - `target` string
        - `environment` DbtProjectEnvironmentVariable[]
          - `value` string, required
          - `key` string, required
        - `selector` string
        - `profiles_dir` string
        - `project_dir` string
      - DbtCloudIDEProjectConfig
        - `type` 'dbt_cloud_ide', required
        - `api_key` string, required
        - `environment_id` string, required
        - `discovery_api_endpoint` string
        - `tags` string[]
        - `webhook_hmac_secret` string
      - DbtGithubProjectConfig
        - `type` 'github', required
        - `target` string
        - `environment` DbtProjectEnvironmentVariable[]
          - `value` string, required
          - `key` string, required
        - `selector` string
        - `authorization_method` 'personal_access_token' | 'installation_id', required
        - `personal_access_token` string
        - `installation_id` string
        - `repository` string, required
        - `branch` string, required
        - `project_sub_path` string, required
        - `host_domain` string
      - DbtBitBucketProjectConfig
        - `type` 'bitbucket', required
        - `target` string
        - `environment` DbtProjectEnvironmentVariable[]
          - `value` string, required
          - `key` string, required
        - `selector` string
        - `username` string, required
        - `personal_access_token` string, required
        - `repository` string, required
        - `branch` string, required
        - `project_sub_path` string, required
        - `host_domain` string
      - DbtGitlabProjectConfig
        - `type` 'gitlab', required
        - `target` string
        - `environment` DbtProjectEnvironmentVariable[]
          - `value` string, required
          - `key` string, required
        - `selector` string
        - `personal_access_token` string, required
        - `repository` string, required
        - `branch` string, required
        - `project_sub_path` string, required
        - `host_domain` string
      - DbtAzureDevOpsProjectConfig
        - `type` 'azure_devops', required
        - `target` string
        - `environment` DbtProjectEnvironmentVariable[]
          - `value` string, required
          - `key` string, required
        - `selector` string
        - `personal_access_token` string, required
        - `organization` string, required
        - `project` string, required
        - `repository` string, required
        - `branch` string, required
        - `project_sub_path` string, required
      - DbtNoneProjectConfig
        - `type` 'none', required
        - `target` string
        - `environment` DbtProjectEnvironmentVariable[]
          - `value` string, required
          - `key` string, required
        - `selector` string
        - `hideRefreshButton` boolean
      - DbtManifestProjectConfig
        - `type` 'manifest', required
        - `manifest` string, required
        - `hideRefreshButton` boolean, required
    - `type` 'DEFAULT' | 'PREVIEW', required
    - `name` string, required
    - `projectUuid` string, required
    - `organizationUuid` string, required
  - `status` 'ok', required

## Other responses

- `default` — Error

---

[API](https://skmtc.net/lightdash/apis/lightdash-api.md) · [All operations](https://skmtc.net/lightdash/apis/lightdash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightdash/lightdash-api/versions/40c933755c9a/schema)