Get the setup steps of a site

Lists the steps to set up a site, from a first edit to publishing, and whether each one is completed. Use it to know what is left to do on a site. Returns no steps once the site has been published.

Available in MCP

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

Responses

200

OK

application/json

Steps to set up a site, each completed or not from the site's current data.

400

Bad Request

application/json

get/orgs/{organizationId}/sites/{siteId}/setup

GET /v1/orgs/{organizationId}/sites/{siteId}/setup HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "steps": [
    {
      "id": "first-edit",
      "completed": true,
      "action": "text"
    }
  ]
}