Diese Seite wurde noch nicht in Ihre Sprache übersetzt. Angezeigt wird die Version Englisch (Vereinigtes Königreich).
Setup
Read the onboarding steps for you and your agency, network and trial, and record that a step was done, skipped or put away.
The setup API returns the onboarding steps for the signed-in person and, for an admin, for the agency. Onboarding has two tiers: every organization is on the Fondaro Network from sign-up and gets the network steps; once it has a plan or its free trial, the trial steps follow them. Fondaro works out whether a step is done from what the step produces, so the only thing you write is a person's choice to mark a step done, skip it or put the page away.
These endpoints take a signed-in member's session token (Authorization: Bearer <session-token>); API keys do not open them. See Authentication.
Read your setup
GET /me/setup
Returns your own steps and, for an organization admin, the agency's steps, invitations and what is already on. Takes no parameters.
| Field | Type | Description |
|---|---|---|
role | admin or member | Your role in the organization |
tier | network or trial | network for an organization with no plan (the network steps are listed), trial once it has a plan or its trial (the trial steps are listed instead) |
plan.kind | none, crm, growth or crm_and_growth | The plans the organization holds |
plan.trialing, plan.trialEndsAt | boolean, string or null | Whether the organization is in its free trial, and when it ends |
plan.trialPrice | object, optional | A trialing CRM plan only: { seatCount, amountCents, currency }, the monthly price once the trial ends |
entitled | boolean | true once a plan or the trial is on |
teamMode | solo or team | Solo is one person and no invitation; the team step is then hidden |
dismissed | boolean | "I'm done" for this tier: by an admin for all admins, or by you as a member. Putting the network steps away does not hide the trial steps a plan brings later |
welcomed | boolean | You have seen the network welcome |
agency | step[] or null | Admins only |
you | step[] | Your own steps |
prompts | step[] | Your later things, not steps: profile (your languages and areas) and app. Never counted in progress |
progress | { done, total } | Counts the listed steps that are not hidden |
invitations | array | Admins only, newest first. status is pending, accepted or revoked |
kicked | { name, at }[] | Admins only: people removed in the last 30 days because the team was over its plan's people |
alreadyOn | object or null | Admins only: whether Fondaro's AI, Smart routing and Calling are on |
Steps
Each step is { id, tier, status, missing, hidden, detail }. status is done, open or skipped. A step is done when what it produces exists; otherwise the latest recorded choice decides. Choices on agency steps count from any admin; choices on your own steps count only from you. missing names what the step still needs (empty once done): name, logo, listing, photo, languages, areas, or action for a step whose own flow decides.
One tier's steps are listed at a time, in this order: without a plan the network steps; with one the trial steps, Talk to Fondaro first.
id | Tier | Group | Done when |
|---|---|---|---|
agency | Network | Agency | The agency name and both logos are set (the dark logo is made from the one you upload) |
listings | Network | Agency | The agency has an active home of its own, a Resales Online import has finished, or the agency asked Fondaro to set up Resales Online (detail.resalesHelp). detail.inReview counts homes added by hand that are waiting for approval |
photo | Network | You | You have a profile photo |
talk | Trial | You | Your WhatsApp is linked to Fondaro, you chose Fondaro in your email, or you made a choice in the Talk to Fondaro dialog. Listed while the organization's AI is on |
billing | Trial | Agency | The billing details are complete. Listed only in the trial's last three days |
phone | Trial | You | Your own number is verified and assigned to you |
email | Trial | You | Your own inbox is connected and working |
leads | Trial | Agency | A lead exists, leads were imported, or a listing source is connected |
team | Trial | Agency | Two or more people are on the team, or an invitation was sent |
The prompts, in prompts, have the same shape:
id | Done when |
|---|---|
profile | Your network profile lists a language and an area |
app | You signed in on the phone app, or said you installed it (a done choice) |
Record a step
POST /me/setup/events
Records that you did, skipped or put away a step. The person is always the caller.
| Parameter | Type | Required | Description |
|---|---|---|---|
step | Body, string | Yes | A step or prompt id above; resales-help to ask Fondaro to set up Resales Online; setup-network or setup for the whole page in the network or the trial tier; welcome for the network welcome. Must match ^[a-z][a-z0-9_-]{0,39}$ |
action | Body, done, skipped or dismissed | Yes | What you did |
Returns 204 No Content.
{ "step": "setup-network", "action": "dismissed" } (or "setup" in the trial tier) puts the page away: from an admin, for every admin of the organization; from a member, for that member only. Nothing is deleted; the latest choice per person and step wins, and a step that later becomes done reads as done.
Errors
| Status | When |
|---|---|
400 | step is not a short lowercase key, or action is not one of the three values |
401 | No valid session token |
403 | The caller is not a member of the organization |