---
title: "Read source workspace status"
method: GET
path: "/v1/spaces/{spaceId}/source/workspaces/{workspaceId}"
tags: ["Git"]
---

# Read source workspace status

`GET /v1/spaces/{spaceId}/source/workspaces/{workspaceId}`

## Request

- Base URL: `https://api.spacefast.com`
- URL: `https://api.spacefast.com/v1/spaces/{spaceId}/source/workspaces/{workspaceId}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://api.spacefast.com/v1/auth/oauth2/authorize`, token URL `https://api.spacefast.com/v1/auth/oauth2/token`; client credentials, token URL `https://api.spacefast.com/v1/auth/oauth2/token`, scopes: `spaces:read`)

Read the workspace from data.workspace in the API response. It contains the current revision, saved base, working snapshot, and staged snapshot. Use its id as workspaceId in later requests. This does not change files.

## Path parameters

- `spaceId` string, required
- `workspaceId` string, required

## Response `200`

Response for status 200

- object
  - `$schema` string, uri: Canonical JSON Schema URL for this response body. The server also sends it in the `Link: rel="describedby"` response header.
  - `data` object, required
    - `workspace` object, required
      - `id` string, required
      - `spaceId` string, required
      - `repositoryId` string, required
      - `targetBranch` string, required
      - `name` string, required
      - `revision` integer, required
      - `state` 'initializing' | 'active' | 'conflicted' | 'closed', required
      - `baseCommitSha` string, nullable, required
      - `indexCommitSha` string, nullable, required
      - `workingCommitSha` string, nullable, required
      - `headCommitSha` string, nullable, required
      - `originalUploadVersionId` string, nullable, required
      - `hasStagedChanges` boolean, required
      - `hasUnstagedChanges` boolean, required
      - `hasPendingChanges` boolean, required
      - `needsSync` boolean, required
      - `pendingOperationId` string, nullable, required
      - `autoDeploy` boolean, required
      - `createdAt` string, required
      - `updatedAt` string, required
    - `commit` object
      - `sourceCommitSha` string, required
      - `parentSourceCommitSha` string, required
      - `message` string, required
      - `autoDeploy` boolean, required
    - `conflicts` object
      - `phase` 'staged' | 'working' | 'undo', required
      - `labels` object, required
        - `ours` string, required
        - `theirs` string, required
      - `files` object[], required
        - `path` string, required
        - `result` string, required
        - `base` object, required
          - `sourceCommitSha` string, required
          - `content` string, nullable, required
          - `exists` boolean, required
          - `binary` boolean, required
          - `truncated` boolean, required
          - `mode` string, nullable, required
        - `ours` object, required
          - `sourceCommitSha` string, required
          - `content` string, nullable, required
          - `exists` boolean, required
          - `binary` boolean, required
          - `truncated` boolean, required
          - `mode` string, nullable, required
        - `theirs` object, required
          - `sourceCommitSha` string, required
          - `content` string, nullable, required
          - `exists` boolean, required
          - `binary` boolean, required
          - `truncated` boolean, required
          - `mode` string, nullable, required

## Other responses

- `default`: Problem details (RFC 9457). Any 4xx/5xx response is one `application/problem+json` document.

---

[API](https://skmtc.dev/spacefast/apis/spacefast-api.md) · [All operations](https://skmtc.dev/spacefast/apis/spacefast-api/llms.txt) · [OpenAPI document](https://skmtc.dev/spacefast/apis/spacefast-api/revisions/bd165bc7c983?raw)
