# Onboarding

## Get onboarding status for a project

> Returns computed onboarding status including step completion, feature group readiness, and overall stage (onboarding vs dashboard).

```json
{"openapi":"3.0.0","info":{"title":"sfp server","version":"51.9.0"},"security":[{"access-token":[]}],"components":{"securitySchemes":{"access-token":{"scheme":"bearer","bearerFormat":"JWT","type":"http","in":"header"}},"schemas":{"OnboardingStatusDto":{"type":"object","properties":{"stage":{"type":"string","enum":["onboarding","dashboard"],"description":"dashboard if any feature is fully onboarded, onboarding otherwise"},"steps":{"description":"Completion state of each onboarding step","allOf":[{"$ref":"#/components/schemas/OnboardingStepsDto"}]},"features":{"type":"object","description":"Per-feature-group onboarding status"},"anyFeatureActive":{"type":"boolean","description":"True if at least one feature group is fully completed"},"allFeaturesActive":{"type":"boolean","description":"True if all feature groups are fully completed"},"isPreflightCompleted":{"type":"boolean","description":"True if project preflight status is already-configured"}},"required":["stage","steps","features","anyFeatureActive","allFeaturesActive","isPreflightCompleted"]},"OnboardingStepsDto":{"type":"object","properties":{"appIntegration":{"type":"boolean","description":"Platform integration (GitHub/ADO) is healthy"},"devHub":{"type":"boolean","description":"At least one Dev Hub org is connected"},"preflight":{"type":"boolean","description":"Project preflight status is already-configured"},"configureWebhooks":{"type":"boolean","description":"At least one webhook is configured for the project"},"hasOrg":{"type":"boolean","description":"At least one Salesforce org is registered in the tenant"}},"required":["appIntegration","devHub","preflight","configureWebhooks","hasOrg"]}}},"paths":{"/sfp/api/onboarding/status/{identifier}":{"get":{"operationId":"OnboardingStatusController_getOnboardingStatus","summary":"Get onboarding status for a project","description":"Returns computed onboarding status including step completion, feature group readiness, and overall stage (onboarding vs dashboard).","parameters":[{"name":"identifier","required":true,"in":"path","description":"Project identifier (e.g. flxbl-io/sf-core or org/project/repo for Azure DevOps)","schema":{"type":"string"}}],"responses":{"200":{"description":"Onboarding status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingStatusDto"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - Requires role: member, application"}},"tags":["Onboarding"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.flxbl.io/flxbl/sfp-server/api-reference/onboarding.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.