How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

B3 onboarding API

The onboarding API from B3 — 6 operation(s) for onboarding.

B3 onboarding API is one of 39 APIs that B3 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Onboarding. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 6 paths, and defines 18 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against the base URL https://api.b3os.org/v1.

8 operations 6 paths 18 schemas 1 DELETE4 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.b3os.org/v1
Resource Areas
1

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

onboarding 8
GET
/v1/admin/onboarding/analytics
[ADMIN] Get onboarding analytics
→ 200403500
GET
/v1/admin/onboarding/questions
[ADMIN] Get all onboarding questions (including inactive)
1 param → 200400403500
POST
/v1/admin/onboarding/questions
[ADMIN] Create a new onboarding question
body → 201400403500
DELETE
/v1/admin/onboarding/questions/{questionId}
[ADMIN] Delete an onboarding question
1 param → 200400403404500
PATCH
/v1/admin/onboarding/questions/{questionId}
[ADMIN] Update an existing onboarding question
1 param body → 200400403404500
GET
/v1/onboarding/questions
Get active onboarding questions for the specified scope
3 params → 200400500
POST
/v1/onboarding/responses
Submit onboarding responses and mark onboarding as complete
body → 200400401500
GET
/v1/onboarding/status
Get user's onboarding completion status
→ 200401500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are AdminOnboardingQuestionResponse (10 properties), AdminCreateOnboardingQuestionParams (8 properties), AdminUpdateOnboardingQuestionParams (7 properties), OnboardingQuestionResponse (6 properties). Each schema is shown below with its type and property counts.

OnboardingAnalyticsResponse
object
4 properties
PaginatedData-schemas_OnboardingQuestionResponse
object
4 properties
AdminUpdateOnboardingQuestionParams
object
7 properties
AdminOnboardingQuestionResponse
object
10 properties
GetOnboardingQuestionsSuccessResponse
object
4 properties
AdminGetAllOnboardingQuestionsSuccessResponse
object
4 properties
AdminCreateOnboardingQuestionSuccessResponse
object
4 properties
OnboardingStatusResponse
object
2 properties
SubmitOnboardingResponsesParams
object
1 property 1 required
OnboardingResponseRequest
object
3 properties 3 required
AdminUpdateOnboardingQuestionSuccessResponse
object
4 properties
SubmitOnboardingResponsesSuccessResponse
object
3 properties
AdminCreateOnboardingQuestionParams
object
8 properties 5 required
AdminGetOnboardingAnalyticsSuccessResponse
object
4 properties
AdminDeleteOnboardingQuestionSuccessResponse
object
3 properties
OnboardingQuestionResponse
object
6 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse
object
4 properties
GetOnboardingStatusSuccessResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

b3-onboarding-api-openapi.yml Raw ↑

Other APIs B3 publishes across the network.

B3 Action API
B3 Actions API
B3 Admin API
B3 Ai API
B3 Api Keys API
B3 Connector Types API
B3 Connectors API
B3 Contract API
B3 Contracts API
B3 CU API
B3 faucet API
B3 Integrations API
Where this information came from

This is an independent, third-party profile of B3 onboarding API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.