curl -X GET "https://api.affonso.io/v1/onboarding-form" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"id": "cmf8onb0001p3010onbform1",
"name": "Affiliate Onboarding",
"description": "Tell us a bit about how you plan to promote our product.",
"created_at": "2024-04-10T08:00:00.000Z",
"updated_at": "2024-04-15T14:30:00.000Z",
"questions": [
{
"id": "cmq1onb000onbq1",
"question": "Which channels will you use to promote us?",
"type": "multiple_choice",
"is_required": true,
"options": ["YouTube", "Newsletter", "Blog", "Social"],
"order": 0
},
{
"id": "cmq1onb000onbq2",
"question": "Tell us about your audience",
"type": "textarea",
"is_required": false,
"options": [],
"order": 1
}
]
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "No onboarding form found for your team"
}
}
Affiliate Onboarding
Get Onboarding Form
Retrieve your team’s custom onboarding form together with its active questions
GET
/
v1
/
onboarding-form
curl -X GET "https://api.affonso.io/v1/onboarding-form" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"id": "cmf8onb0001p3010onbform1",
"name": "Affiliate Onboarding",
"description": "Tell us a bit about how you plan to promote our product.",
"created_at": "2024-04-10T08:00:00.000Z",
"updated_at": "2024-04-15T14:30:00.000Z",
"questions": [
{
"id": "cmq1onb000onbq1",
"question": "Which channels will you use to promote us?",
"type": "multiple_choice",
"is_required": true,
"options": ["YouTube", "Newsletter", "Blog", "Social"],
"order": 0
},
{
"id": "cmq1onb000onbq2",
"question": "Tell us about your audience",
"type": "textarea",
"is_required": false,
"options": [],
"order": 1
}
]
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "No onboarding form found for your team"
}
}
Each team can configure a single custom onboarding form that affiliates fill out as part of their onboarding flow. This endpoint returns the form’s metadata and the ordered list of currently active questions.
Returns
404 NOT_FOUND when no onboarding form has been created for your team yet.
Response
boolean
Always
true for successful responsesobject
The onboarding form object.
Show Data Object Properties
Show Data Object Properties
string
Unique identifier for the form
string
Form display name (max 200 characters)
string | null
Optional form description (max 1000 characters)
string
ISO 8601 timestamp of when the form was created
string
ISO 8601 timestamp of the last update
array
Active questions in display order.
Show Question Properties
Show Question Properties
string
Unique identifier for the question
string
The question prompt shown to the affiliate
string
Question type. One of
single_choice, multiple_choice, text_input, textarea.boolean
Whether an answer is required to complete onboarding
array
Available choices for
single_choice and multiple_choice questions. Empty array for text questions.integer
0-based position used to sort questions in the form
curl -X GET "https://api.affonso.io/v1/onboarding-form" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"id": "cmf8onb0001p3010onbform1",
"name": "Affiliate Onboarding",
"description": "Tell us a bit about how you plan to promote our product.",
"created_at": "2024-04-10T08:00:00.000Z",
"updated_at": "2024-04-15T14:30:00.000Z",
"questions": [
{
"id": "cmq1onb000onbq1",
"question": "Which channels will you use to promote us?",
"type": "multiple_choice",
"is_required": true,
"options": ["YouTube", "Newsletter", "Blog", "Social"],
"order": 0
},
{
"id": "cmq1onb000onbq2",
"question": "Tell us about your audience",
"type": "textarea",
"is_required": false,
"options": [],
"order": 1
}
]
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "No onboarding form found for your team"
}
}
Notes
- Only questions with
status: trueare returned. Soft-deleted questions are excluded. - Each team has at most one onboarding form. To modify it, use
PATCH /v1/onboarding-form.
Was this page helpful?