> For the complete documentation index, see [llms.txt](https://support.attackforge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.attackforge.com/attackforge-enterprise/modules/self-service-restful-api/getprojectworkspace.md).

# GetProjectWorkspace

## Parameters

The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.

### Headers

```
GET /api/ss/project/:id/workspace HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close
```

### Query

**id (string)**

Identifier for the project.

Example:

```
GET /api/ss/project/5f63de24fa1c9208d3e140b0/workspace HTTP/1.1
```

## Example

The following example is a cURL request to get a project workspace by the project id.

### Request

Include API Token instead of stars in 'X-SSAPI-KEY: \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*' parameter.

```
curl -X GET 'https://demo.attackforge.com/api/ss/project/5f63de24fa1c9208d3e140b0/workspace' -H 'Host: localhost:3000' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'
```

### Response

Response contains a workspace object.

```
{
   "workspace": {
      "notes": [
         {
            "title": "...",
            "details": "...",
            "details_html": "...",
            "details_type": "PLAINTEXT/RICHTEXT",
            "assets": [
               {
                  "name": "...", 
                  "id": "..."
               }
            ],
            "files": [
               {
                  "name": "...", 
                  "type": "...", 
                  "file_size": 999,
                  "file_size_kb": 99999,
                  "full_name": "...", 
                  "created": "...", 
                  "created_by": "...", 
                  "id": "..."
               }
            ],
            "created": "...",
            "created_by": "...",
            "last_updated": "...",
            "id": "..."
         }
      ],
      "files": [
         {
            "name": "...",
            "type": "...",
            "file_size": 999,
            "file_size_kb": 99999,
            "full_name": "...",
            "created": "...",
            "created_by": "...",
            "id": "..."
         }
      ],
      "logs": [
         {
            "name": "...",
            "type": "...",
            "file_size": 999,
            "file_size_kb": 99999,
            "full_name": "...",
            "created": "...",
            "created_by": "...",
            "id": "..."
         }
      ]
   }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://support.attackforge.com/attackforge-enterprise/modules/self-service-restful-api/getprojectworkspace.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.