---
title: "GET /organization/{organizationId}/workspace"
method: GET
path: "/organization/{organizationId}/workspace"
tags: ["workspace"]
---

# GET /organization/{organizationId}/workspace

`GET /organization/{organizationId}/workspace`

## Request

- Base URL: `https://4014930676-files.gitbook.io/api/v1`
- URL: `https://4014930676-files.gitbook.io/api/v1/organization/{organizationId}/workspace`
- Auth: none declared
- TypeScript: <https://skmtc.dev/terrakube/apis/elide-service/docs/organization/:organizationId/workspace/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the relationship workspace

## Query parameters

- `sort` string[]
- `fields[workspace]` string[]
- `include` string[]
- `filter[workspace]` string
- `page[number]` integer
- `page[size]` integer
- `page[offset]` integer
- `page[limit]` integer
- `page[totals]` string

## Response `200`

Successful response

- object
  - `data` Workspace[]
    - `type` string: Create Permissions : (team manage workspace) Delete Permissions : (team manage workspace)
    - `id` string
    - `attributes` object
      - `branch` string: Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
      - `description` string: Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
      - `folder` string: Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
      - `locked` boolean: Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
      - `name` string: Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
      - `source` string: Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
      - `terraformVersion` string: Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
    - `relationships` object
      - `history` object: Read Permissions : (team view workspace) Update Permissions : (user is a super service)
        - `id` string
        - `type` 'history'
      - `job` object: Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
        - `id` string
        - `type` 'job'
      - `organization` object: Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
        - `id` string
        - `type` 'organization'
      - `schedule` object: Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
        - `id` string
        - `type` 'schedule'
      - `ssh` object: Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
        - `id` string
        - `type` 'ssh'
      - `variable` object: Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
        - `id` string
        - `type` 'variable'
      - `vcs` object: Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
        - `id` string
        - `type` 'vcs'
  - `included` object[]: Included resources
    - `attributes` object
    - `id` string
    - `relationships` object
    - `type` string

---

[API](https://skmtc.dev/terrakube/apis/elide-service.md) - [All operations](https://skmtc.dev/terrakube/apis/elide-service/llms.txt) - [OpenAPI document](https://skmtc.dev/terrakube/apis/elide-service/revisions/e7891deb8c02?raw)