API Reference Get Onboarding
Get Onboarding
Where you are in setting up your account: verify email, about you, first project, first publish.
Session token
Returns your progress through the dashboard's setup flow — Verify email → About you → Create project → Publish — and your About you answers. The dashboard uses it to decide whether to send you to /onboarding.
Note
Requires a session JWT — a dashboard session or an stx login token. API keys are rejected with 401. Any plan.
Nothing here is stored as progress. Every step is worked out from your account each time you ask:
| Step | id | Done when | Skippable |
|---|---|---|---|
| Verify email | verify | Your email address is verified | No |
| About you | profile | You answered or skipped the questions | Yes |
| Create project | project | A workspace you belong to has a project that isn't deleted | No |
| Publish | publish | One of those projects has a production build that deployed — previews don't count | No |
So a project created in the CLI, or a workspace you were invited to that already has one, counts.
Response — 200 OK
NameDescription
requiredtrue while Verify email or Create project isn't done. The dashboard keeps you in the setup flow until it's false; About you and Publish don't hold you there.stepsThe four steps, always in the order
verify, profile, project, publish. Each has id, status and skippable.steps[].statusdone, current — the first step that isn't done — or todo for the steps after it. Every step can be done while an earlier one isn't: publishing before you verify still marks publish done.steps[].skippableOnly
profile is skippable.answersYour About you answers, in the shape Save Onboarding Answers takes, with
heardFrom as null when you left it blank. null when you skipped the questions or haven't answered yet.Error Responses
401 Unauthorized
unauthorized for a missing, invalid or expired token (or an API key); session_revoked when the session has been signed out.
Was this page helpful? Yes No
Previous
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/me/onboarding \
-H "Authorization: Bearer $SYNTEXT_JWT"
// A browser has no environment variables: set these to your values.
const SYNTEXT_JWT = '<SYNTEXT_JWT>';
const response = await fetch('https://api.syntext.dev/v1/me/onboarding', {
method: 'GET',
headers: {
'Authorization': `Bearer ${SYNTEXT_JWT}`,
},
});
const data = await response.json();
console.log(response.status, data);
import os
import requests
url = "https://api.syntext.dev/v1/me/onboarding"
headers = {
"Authorization": f"Bearer {os.environ['SYNTEXT_JWT']}",
}
response = requests.get(url, headers=headers)
print(response.status_code)
print(response.json())
package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest("GET", "https://api.syntext.dev/v1/me/onboarding", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("SYNTEXT_JWT"))
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
panic(err)
}
fmt.Println(res.Status)
fmt.Println(string(body))
}
require "net/http"
require "uri"
uri = URI("https://api.syntext.dev/v1/me/onboarding")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("SYNTEXT_JWT")}"
response = http.request(request)
puts response.code
puts response.body
<?php
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => 'https://api.syntext.dev/v1/me/onboarding',
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('SYNTEXT_JWT'),
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);
echo $status, PHP_EOL, $response, PHP_EOL;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.syntext.dev/v1/me/onboarding"))
.header("Authorization", "Bearer " + System.getenv("SYNTEXT_JWT"))
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}
using System.Net.Http;
using System.Text;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.syntext.dev/v1/me/onboarding");
request.Headers.TryAddWithoutValidation("Authorization", "Bearer " + Environment.GetEnvironmentVariable("SYNTEXT_JWT"));
using var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
Responseapplication/json
200OK
{
"data": {
"required": true,
"steps": [
{ "id": "verify", "status": "done", "skippable": false },
{ "id": "profile", "status": "done", "skippable": true },
{ "id": "project", "status": "current", "skippable": false },
{ "id": "publish", "status": "todo", "skippable": false }
],
"answers": {
"documenting": ["help_center", "api_docs"],
"role": "engineer",
"teamSize": "2_10",
"heardFrom": null
}
}
}