Retrieve the setup checklist

GET/v1/onboarding

The workspace's setup checklist, in order: the same steps the dashboard shows. Only steps marked required count towards completed. New keys may appear; skip any you do not recognise. Steps only owners can finish, such as connecting an app with a key, are left out for API keys.

Returns

Returns 200 OK with a Onboarding in data. Otherwise returns an error; Errors lists every code and which to retry.

completedbooleanrequired

dismissedbooleanrequired

stepsOnboardingStep[]required

6 child attributes

donebooleanrequired
unverifiedDomainCountintegeroptional: min 0 · max 9007199254740991
missingstring[]optional
campaignIdstring | nulloptional: uuid
keystringrequired: one of domain, address, brand, push, audience, message, send, engagement, app
requiredbooleanrequired

curl https://api.kirora.io/v1/onboarding \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/onboarding', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
const { data } = await response.json();

import os

import requests

response = requests.get(
    "https://api.kirora.io/v1/onboarding",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
)
data = response.json()["data"]

package main

import (
	"encoding/json"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.kirora.io/v1/onboarding", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

Response · 200

{
  "data": {
    "completed": true,
    "dismissed": true,
    "steps": [
      {
        "done": true,
        "key": "domain",
        "required": true
      }
    ]
  }
}

Example values are generated from the schema.