Workspaces

Get workspace setup progress

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

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

Path parameters

idstring required

Workspace ID

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

action_hrefstring

Safe same-origin application route for the next setup action

activatedboolean required

Whether the Workspace has a connected destination and a scheduled or submitted Publication

completed_stepsinteger 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

total_stepsinteger required

Number of applicable setup steps

visibleboolean required

Whether the current user has an applicable, authorized incomplete setup step

Example response

{
  "$schema": "https://example.com/api/v1/schemas/WorkspaceSetupResponse.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.