---
title: "Get workspace setup progress"
method: GET
path: "/workspaces/{id}/setup"
tags: ["Workspaces"]
---

# Get workspace setup progress

`GET /workspaces/{id}/setup`

## Request

- Base URL: `https://app.openpo.st/api/v1`
- URL: `https://app.openpo.st/api/v1/workspaces/{id}/setup`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `openpost_session`

Projects role- and deployment-applicable setup progress from the Workspace, subscription, connected-destination, and Publication state without storing a separate onboarding step index.

## Path parameters

- `id` string, required: Workspace ID

## Response `200`

OK

- WorkspaceSetupResponse
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `action_href` string: Safe same-origin application route for the next setup action
  - `activated` boolean, required: Whether the Workspace has a connected destination and a scheduled or submitted Publication
  - `completed_steps` integer, required: Number of completed setup steps
  - `next_action` 'name_workspace' | 'resume_checkout' | 'connect_destination' | 'create_publication': Authorized action for the next setup step
  - `next_step` 'workspace' | 'subscription' | 'destination' | 'composition' | 'publication': First incomplete setup step available to the current user
  - `steps` WorkspaceSetupStepResponse[], nullable, required: Ordered authoritative setup progress applicable to the current user's role and deployment
    - `completed` boolean, required: Whether the authoritative product state completes this step
    - `id` 'workspace' | 'subscription' | 'destination' | 'composition' | 'publication', required: Setup step derived from Workspace state
  - `total_steps` integer, required: Number of applicable setup steps
  - `visible` boolean, required: Whether the current user has an applicable, authorized incomplete setup step

## Other responses

- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Entity
- `500`: Internal Server Error

---

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