Stay organized with collections
Save and categorize content based on your preferences.
Version 4.0.25.14 (latest)
Get A Workspace
Returns information about a workspace such as the git status and selected branches
of all projects available to the caller's user account.
A workspace defines which versions of project files will be used to evaluate expressions
and operations that use model definitions - operations such as running queries or rendering dashboards.
Each project has its own git repository, and each project in a workspace may be configured to reference
particular branch or revision within their respective repositories.
There are two predefined workspaces available: "production" and "dev".
The production workspace is shared across all Looker users. Models in the production workspace are read-only.
Changing files in production is accomplished by modifying files in a git branch and using Pull Requests
to merge the changes from the dev branch into the production branch, and then telling
Looker to sync with production.
The dev workspace is local to each Looker user. Changes made to project/model files in the dev workspace only affect
that user, and only when the dev workspace is selected as the active workspace for the API session.
(See set_session_workspace()).
The dev workspace is NOT unique to an API session. Two applications accessing the Looker API using
the same user account will see the same files in the dev workspace. To avoid collisions between
API clients it's best to have each client login with API credentials for a different user account.
Changes made to files in a dev workspace are persistent across API sessions. It's a good
idea to commit any changes you've made to the git repository, but not strictly required. Your modified files
reside in a special user-specific directory on the Looker server and will still be there when you login in again
later and use update_session(workspace_id: "dev") to select the dev workspace for the new API session.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[],[],null,["# Get Workspace\n\nVersion 4.0.25.14 (latest)\n\n### Get A Workspace\n\nReturns information about a workspace such as the git status and selected branches\nof all projects available to the caller's user account.\n\nA workspace defines which versions of project files will be used to evaluate expressions\nand operations that use model definitions - operations such as running queries or rendering dashboards.\nEach project has its own git repository, and each project in a workspace may be configured to reference\nparticular branch or revision within their respective repositories.\n\nThere are two predefined workspaces available: \"production\" and \"dev\".\n\nThe production workspace is shared across all Looker users. Models in the production workspace are read-only.\nChanging files in production is accomplished by modifying files in a git branch and using Pull Requests\nto merge the changes from the dev branch into the production branch, and then telling\nLooker to sync with production.\n\nThe dev workspace is local to each Looker user. Changes made to project/model files in the dev workspace only affect\nthat user, and only when the dev workspace is selected as the active workspace for the API session.\n(See set_session_workspace()).\n\nThe dev workspace is NOT unique to an API session. Two applications accessing the Looker API using\nthe same user account will see the same files in the dev workspace. To avoid collisions between\nAPI clients it's best to have each client login with API credentials for a different user account.\n\nChanges made to files in a dev workspace are persistent across API sessions. It's a good\nidea to commit any changes you've made to the git repository, but not strictly required. Your modified files\nreside in a special user-specific directory on the Looker server and will still be there when you login in again\nlater and use update_session(workspace_id: \"dev\") to select the dev workspace for the new API session.\n\nRequest\n-------\n\nGET /workspaces/{workspace_id} \nDatatype \nDescription \nRequest \nHTTP Request \npath \nHTTP Path \nExpand HTTP Path definition... \nworkspace_id \nstring \nId of the workspace\n\nResponse\n--------\n\n### 200: Workspace\n\nDatatype \nDescription \n(object) \n[Workspace](/looker/docs/reference/looker-api/latest/types/Workspace) \ncan \n*lock* \nobject \nOperations the current user is able to perform on this object \nid \n*lock* \nstring \nThe unique id of this user workspace. Predefined workspace ids include \"production\" and \"dev\" \nprojects \n[Project](/looker/docs/reference/looker-api/latest/types/Project)\\[\\] \nExpand Project definition... \ncan \n*lock* \nobject \nOperations the current user is able to perform on this object \nid \n*lock* \nstring \nProject Id \nname \nstring \nProject display name \nuses_git \n*lock* \nboolean \nIf true the project is configured with a git repository \ngit_remote_url \nstring \nGit remote repository url \ngit_username \nstring \nGit username for HTTPS authentication. (For production only, if using user attributes.) \ngit_password \nstring \n(Write-Only) Git password for HTTPS authentication. (For production only, if using user attributes.) \ngit_production_branch_name \nstring \nGit production branch name. Defaults to master. Supported only in Looker 21.0 and higher. \nuse_git_cookie_auth \nboolean \nIf true, the project uses a git cookie for authentication. \ngit_username_user_attribute \nstring \nUser attribute name for username in per-user HTTPS authentication. \ngit_password_user_attribute \nstring \nUser attribute name for password in per-user HTTPS authentication. \ngit_service_name \nstring \nName of the git service provider \ngit_application_server_http_port \ninteger \nPort that HTTP(S) application server is running on (for PRs, file browsing, etc.) \ngit_application_server_http_scheme \nstring \nScheme that is running on application server (for PRs, file browsing, etc.) \ndeploy_secret \nstring \n(Write-Only) Optional secret token with which to authenticate requests to the webhook deploy endpoint. If not set, endpoint is unauthenticated. \nunset_deploy_secret \nboolean \n(Write-Only) When true, unsets the deploy secret to allow unauthenticated access to the webhook deploy endpoint. \npull_request_mode \nstring \nThe git pull request policy for this project. Valid values are: \"off\", \"links\", \"recommended\", \"required\". \nvalidation_required \nboolean \nValidation policy: If true, the project must pass validation checks before project changes can be committed to the git repository \ngit_release_mgmt_enabled \nboolean \nIf true, advanced git release management is enabled for this project \nallow_warnings \nboolean \nValidation policy: If true, the project can be committed with warnings when \\`validation_required\\` is true. (\\`allow_warnings\\` does nothing if \\`validation_required\\` is false). \nis_example \n*lock* \nboolean \nIf true the project is an example project and cannot be modified \ndependency_status \nstring \nStatus of dependencies in your manifest \\& lockfile\n\n### 400: Bad Request\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link\n\n### 404: Not Found\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link\n\n### 429: Too Many Requests\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link\n\nExamples\n--------\n\n### Kotlin"]]
