---
title: "getWorkspace"
canonical: "https://support.appfire.com/space/BCCLI/65765779/getWorkspace"
format: markdown
---
> Macro (aura-html)

See also: [Actions](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65766635)

> Macro (details)
> 
> | **Description** | Get workspace information. |
> | --- | --- |
> | **Required Parameters** | [workspace](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65765634) |
> | **Optional Parameters** | [outputFormat](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65765525), [outputType](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65768516), [file](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65768095), [encoding](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65766303), [append](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65765977), [dateFormat](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65766361) |
> | **Type** | [Get](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65768932/Action+Types#ActionTypes-Get) |
> | **Category** | [Workspaces](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65766329/Action+Categories#ActionCategories-Workspaces) |
> | **Output Formats** |  |
> | **Replacement Variables** | workspace, workspaceKey, workspaceUuid |
> | **Since Version** | 9.7 |
> | **Examples** | [getWorkspace](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65766633/Examples#getWorkspace) |

## Related How To's

> Macro (cql-query)