Get a project
GET/v1/projects/:project_key
Fetch metadata about a project. The service account must have at least a viewer role for this project.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| project_keyrequired | path | string | The unique identifier for the project |
Responses
Successful response
success * boolean
request_id * string
result * object — A project
key * string — The unique identifier for the project
name * string — The display name for the project
created_at * string (date-time) — An ISO 8601 date-time string.
description * string — A description of the project.
modified_at * string (date-time) | null — An ISO 8601 date-time string, or null.
permitted_actions * object — The actions you are allowed to perform in this project
create_canvas * boolean — Are you able to create a canvas or not.
run_query * boolean — Are you able to query data sources in this project or not.
permissions * object[] — The list of actors with assigned permissions for this project.
key * string — The unique identifier for the actor.
role * "admin" | "analyst" | "editor" | "viewer" | "reportViewer" — The assigned project role
type * "user" | "group" | "serviceAccount" | "workspace" — The type of actor.
sources * object[] — The data sources that are accessible through this project.
type * "connection" | "catalog" — The type of data source
source_key * string — The unique identifier for the data source.
source_name * string — The name of the source.
connection_type "athena" | "bigquery" | "databricks" | "mssql" | "mysql" | "postgresql" | "redshift" | "snowflake" | "synapse" | "googlesheets" — The type of connection
datasets string[] — For catalog sources, the explicit list of exposed datasets (if any).
agent_context string — Agent-specific context for this project (if any).