Clients
Onboarding flows
The onboarding flows you've set up, to run one for a client you add.
An onboarding flow is what a coach set up to give a new client in one go, such as their programs, nutrition plans, check-ins, habits, metrics, communities and team members. Pass one's id as onboardingFlowId when creating a client to run it for them, as adding a client with a flow does in the app.
Endpoints
Onboarding flow object
{
"id": "6ad6affacef0fafbcef28df8",
"name": "12-week fat loss"
}GET
https://api.hubfit.com/v1/onboarding-flowsEvery onboarding flow in the workspace, newest first, to pass one as onboardingFlowId when creating a client. A workspace adds no more than 50 (MAX_ONBOARDING_FLOWS_PER_WORKSPACE), so they all come in one response, without paging. Requires clients:create, which creating a client with one needs.
This endpoint takes no parameters.
Returns
Every onboarding flow in the workspace.
GET /v1/onboarding-flows
curl https://api.hubfit.com/v1/onboarding-flows \
-H "Authorization: Bearer $HUBFIT_API_KEY"const response = await fetch("https://api.hubfit.com/v1/onboarding-flows", {
headers: {
Authorization: `Bearer ${process.env.HUBFIT_API_KEY}`,
},
});
const { data } = await response.json();import os
import requests
response = requests.get(
"https://api.hubfit.com/v1/onboarding-flows",
headers={"Authorization": f"Bearer {os.environ['HUBFIT_API_KEY']}"},
)
data = response.json()["data"]Response200 OK
{
"data": [
{
"id": "6ad6affacef0fafbcef28df8",
"name": "12-week fat loss"
}
]
}