/v1/me/getting-startedRead my Getting Started checklist
The signed-in person's Getting Started card: one row per setup step, each read from what actually happened, never ticked by hand. Rows, in order: account (always done), email (a mailbox they connected syncs here), records (the workspace holds a deal, merchant or lead), texting (their Messages reached the app; only when device is mac), team (somebody else holds a seat; only when the wizard's role was brokerage), submission (they sent a deal to a lender). Each row says done and when it first became true. completedAt is when they finished the card, null while it is still theirs to do. device is required: mac, windows or web.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Required device; texting applies on mac only.
"mac" · "windows" · "web"
Responses
the action's answer
{
"data": {
"completedAt": "2026-01-01T00:00:00Z",
"steps": [
{
"done": true,
"doneAt": "2026-01-01T00:00:00Z",
"id": ""
}
]
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}