Read the onboarding state
The whole octolens onboard read model: the current step, its status, the per-step view and what is next. A pure read. Answers for every org with an onboarding marker, including one waiting for review, a paywalled one and a finished one.
curl --request GET \
--url https://app.octolens.com/api/v2/onboarding \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.octolens.com/api/v2/onboarding"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.octolens.com/api/v2/onboarding', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octolens.com/api/v2/onboarding",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.octolens.com/api/v2/onboarding"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.octolens.com/api/v2/onboarding")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octolens.com/api/v2/onboarding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"step": "account",
"status": "needs_input",
"revision": "<string>",
"engine": "sonar",
"handle": {
"orgId": "<string>",
"draftId": "<string>",
"proposalId": "<string>"
},
"completed": [
"account"
],
"reviewed": true,
"pendingReview": true,
"trial": {
"plan": "Free_trial",
"allowance": 4503599627370495,
"startsAt": "on_finish",
"endsAt": "<string>"
},
"view": {
"website": {
"domain": "<string>",
"scanSteps": [
{
"step": "cache",
"status": "pending",
"line": "<string>",
"ms": 4503599627370495
}
],
"profile": {
"name": "<string>",
"description": "<string>",
"industry": "<string>",
"website": "<string>",
"domainVariants": [
"<string>"
],
"productAreas": [
{
"label": "<string>",
"path": "<string>"
}
],
"ownAccounts": [
{
"platform": "x",
"handle": "<string>"
}
],
"founderHandles": [
"<string>"
],
"protectedVocabulary": [
"<string>"
],
"competitors": [
{
"name": "<string>",
"why": "<string>",
"domain": "<string>"
}
],
"relevanceContext": "<string>",
"productUseCases": [
"<string>"
],
"companyMoat": "<string>"
},
"confirmed": true
},
"keywords": {
"proposalStatus": "scanning",
"archetype": "<string>",
"openingLine": "<string>",
"keywords": [
{
"ref": "k1",
"keyword": "<string>",
"tag": "own_brand"
}
],
"slots": {
"used": 4503599627370495,
"of": 123
},
"problems": [
{
"code": "too_many",
"ref": "<string>",
"blocking": true,
"message": "<string>"
}
]
},
"mentions": {
"mode": "setup",
"draftId": "<string>",
"status": "collecting",
"stage": "collecting",
"found": 4503599627370495,
"collectionEnd": "runs_finished",
"progress": 50,
"pairs": {
"expected": 4503599627370495,
"settled": 4503599627370495
},
"tiles": [
{
"source": "twitter",
"label": "<string>",
"state": "done"
}
],
"sources": [
{
"source": "<string>",
"label": "<string>",
"count": 4503599627370495,
"state": "arriving",
"atLeast": true,
"failed": true
}
],
"posts": [
{
"id": 0,
"source": "<string>",
"keyword": "<string>",
"place": {
"preposition": "in",
"name": "<string>"
},
"title": "<string>",
"body": "<string>",
"url": "<string>",
"timestamp": "<string>",
"aboutYou": true,
"giveaway": "<string>",
"whyNot": "<string>",
"sentimentLabel": "<string>",
"tags": [
"<string>"
]
}
],
"total": 4503599627370495,
"aboutYou": 4503599627370495,
"notAboutYou": 4503599627370495,
"proposal": {
"lines": [
{
"keyword": "<string>",
"setting": "additionalTerms",
"values": [
"<string>"
],
"text": "<string>",
"logic": "any",
"split": [
{
"label": "<string>",
"terms": [
"<string>"
]
}
]
}
]
},
"decision": "cleanup",
"cleanedUp": {
"removed": 4503599627370495,
"changes": [
{
"keyword": "<string>",
"text": "<string>",
"setting": "additionalTerms",
"values": [
"<string>"
],
"logic": "any",
"split": [
{
"label": "<string>",
"terms": [
"<string>"
]
}
]
}
],
"undoAvailableUntil": "<string>"
},
"canContinueWithoutDecision": true,
"allowance": 4503599627370495,
"keywords": [
"<string>"
],
"proposalPending": true
},
"feeds": {
"state": "waiting",
"feeds": [
{
"n": 123,
"id": 0,
"name": "<string>",
"kind": "<string>",
"mentions": 4503599627370495,
"description": "<string>"
}
]
},
"slack": {
"connected": true,
"team": "<string>",
"digest": true,
"feeds": [
{
"id": 0,
"name": "<string>",
"channel": {
"id": "<string>",
"name": "<string>"
},
"emailOnly": true
}
],
"handoff": {
"dest": "slack_install",
"url": "https://app.octolens.com/go/K7Q2-MX9P",
"code": "K7Q2-MX9P",
"expiresAt": "<string>"
}
},
"mcp": {
"endpoint": "https://app.octolens.com/api/mcp/v2",
"auth": "oauth",
"connected": true,
"connectedAt": "<string>"
}
},
"next": {
"kind": "run",
"step": "account",
"reason": "<string>",
"retryAfterSeconds": 4503599627370495,
"url": "<string>",
"default": true
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}Authorizations
Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>. Keys carry a scope — read, write (implies read) or admin (implies write) — chosen when the key is minted. Each operation's security requirement (and its x-required-scope extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.
Response
200 response
Where the onboarding is: account → website → keywords → mentions → feeds → slack → mcp → complete.
account, website, keywords, mentions, feeds, slack, mcp, complete needs_input = a decision or value is wanted · running = server work in flight, poll · needs_human = a person must act (open a link, read an email) · pending_review = the workspace waits for manual review · done = nothing left to do.
needs_input, running, needs_human, pending_review, done Hash of the onboarding timestamps, the draft's updatedAt and the marker's tail (--if-revision).
sonar, classic Show child attributes
Show child attributes
Where the onboarding is: account → website → keywords → mentions → feeds → slack → mcp → complete.
account, website, keywords, mentions, feeds, slack, mcp, complete True after manual review approved the workspace (the post-review tail).
Null until the workspace exists (keywords confirmed).
Show child attributes
Show child attributes
The current step's section is set; the others may be null.
Show child attributes
Show child attributes
Null when status is done.
Show child attributes
Show child attributes
Was this page helpful?
curl --request GET \
--url https://app.octolens.com/api/v2/onboarding \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.octolens.com/api/v2/onboarding"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.octolens.com/api/v2/onboarding', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octolens.com/api/v2/onboarding",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.octolens.com/api/v2/onboarding"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.octolens.com/api/v2/onboarding")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octolens.com/api/v2/onboarding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"step": "account",
"status": "needs_input",
"revision": "<string>",
"engine": "sonar",
"handle": {
"orgId": "<string>",
"draftId": "<string>",
"proposalId": "<string>"
},
"completed": [
"account"
],
"reviewed": true,
"pendingReview": true,
"trial": {
"plan": "Free_trial",
"allowance": 4503599627370495,
"startsAt": "on_finish",
"endsAt": "<string>"
},
"view": {
"website": {
"domain": "<string>",
"scanSteps": [
{
"step": "cache",
"status": "pending",
"line": "<string>",
"ms": 4503599627370495
}
],
"profile": {
"name": "<string>",
"description": "<string>",
"industry": "<string>",
"website": "<string>",
"domainVariants": [
"<string>"
],
"productAreas": [
{
"label": "<string>",
"path": "<string>"
}
],
"ownAccounts": [
{
"platform": "x",
"handle": "<string>"
}
],
"founderHandles": [
"<string>"
],
"protectedVocabulary": [
"<string>"
],
"competitors": [
{
"name": "<string>",
"why": "<string>",
"domain": "<string>"
}
],
"relevanceContext": "<string>",
"productUseCases": [
"<string>"
],
"companyMoat": "<string>"
},
"confirmed": true
},
"keywords": {
"proposalStatus": "scanning",
"archetype": "<string>",
"openingLine": "<string>",
"keywords": [
{
"ref": "k1",
"keyword": "<string>",
"tag": "own_brand"
}
],
"slots": {
"used": 4503599627370495,
"of": 123
},
"problems": [
{
"code": "too_many",
"ref": "<string>",
"blocking": true,
"message": "<string>"
}
]
},
"mentions": {
"mode": "setup",
"draftId": "<string>",
"status": "collecting",
"stage": "collecting",
"found": 4503599627370495,
"collectionEnd": "runs_finished",
"progress": 50,
"pairs": {
"expected": 4503599627370495,
"settled": 4503599627370495
},
"tiles": [
{
"source": "twitter",
"label": "<string>",
"state": "done"
}
],
"sources": [
{
"source": "<string>",
"label": "<string>",
"count": 4503599627370495,
"state": "arriving",
"atLeast": true,
"failed": true
}
],
"posts": [
{
"id": 0,
"source": "<string>",
"keyword": "<string>",
"place": {
"preposition": "in",
"name": "<string>"
},
"title": "<string>",
"body": "<string>",
"url": "<string>",
"timestamp": "<string>",
"aboutYou": true,
"giveaway": "<string>",
"whyNot": "<string>",
"sentimentLabel": "<string>",
"tags": [
"<string>"
]
}
],
"total": 4503599627370495,
"aboutYou": 4503599627370495,
"notAboutYou": 4503599627370495,
"proposal": {
"lines": [
{
"keyword": "<string>",
"setting": "additionalTerms",
"values": [
"<string>"
],
"text": "<string>",
"logic": "any",
"split": [
{
"label": "<string>",
"terms": [
"<string>"
]
}
]
}
]
},
"decision": "cleanup",
"cleanedUp": {
"removed": 4503599627370495,
"changes": [
{
"keyword": "<string>",
"text": "<string>",
"setting": "additionalTerms",
"values": [
"<string>"
],
"logic": "any",
"split": [
{
"label": "<string>",
"terms": [
"<string>"
]
}
]
}
],
"undoAvailableUntil": "<string>"
},
"canContinueWithoutDecision": true,
"allowance": 4503599627370495,
"keywords": [
"<string>"
],
"proposalPending": true
},
"feeds": {
"state": "waiting",
"feeds": [
{
"n": 123,
"id": 0,
"name": "<string>",
"kind": "<string>",
"mentions": 4503599627370495,
"description": "<string>"
}
]
},
"slack": {
"connected": true,
"team": "<string>",
"digest": true,
"feeds": [
{
"id": 0,
"name": "<string>",
"channel": {
"id": "<string>",
"name": "<string>"
},
"emailOnly": true
}
],
"handoff": {
"dest": "slack_install",
"url": "https://app.octolens.com/go/K7Q2-MX9P",
"code": "K7Q2-MX9P",
"expiresAt": "<string>"
}
},
"mcp": {
"endpoint": "https://app.octolens.com/api/mcp/v2",
"auth": "oauth",
"connected": true,
"connectedAt": "<string>"
}
},
"next": {
"kind": "run",
"step": "account",
"reason": "<string>",
"retryAfterSeconds": 4503599627370495,
"url": "<string>",
"default": true
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}