curl -X GET "https://api.affonso.io/v1/affiliates/cmj8pptm10002p3010z8mk9ak/onboarding-responses" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"form_id": "cmf8onb0001p3010onbform1",
"form_name": "Affiliate Onboarding",
"form_description": "Tell us a bit about how you plan to promote our product.",
"completed_at": "2024-04-22T17:32:11.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,
"answer": ["Newsletter", "Blog"]
},
{
"id": "cmq1onb000onbq2",
"question": "Tell us about your audience",
"type": "textarea",
"is_required": false,
"options": [],
"order": 1,
"answer": "Mostly indie SaaS founders and bootstrapped teams."
}
]
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "No onboarding form configured for your team"
}
}
Affiliate Onboarding
Get Affiliate Onboarding Responses
Retrieve an affiliate’s saved answers to the onboarding form along with completion status
GET
/
v1
/
affiliates
/
{id}
/
onboarding-responses
curl -X GET "https://api.affonso.io/v1/affiliates/cmj8pptm10002p3010z8mk9ak/onboarding-responses" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"form_id": "cmf8onb0001p3010onbform1",
"form_name": "Affiliate Onboarding",
"form_description": "Tell us a bit about how you plan to promote our product.",
"completed_at": "2024-04-22T17:32:11.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,
"answer": ["Newsletter", "Blog"]
},
{
"id": "cmq1onb000onbq2",
"question": "Tell us about your audience",
"type": "textarea",
"is_required": false,
"options": [],
"order": 1,
"answer": "Mostly indie SaaS founders and bootstrapped teams."
}
]
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "No onboarding form configured for your team"
}
}
Returns the active onboarding form joined with the affiliate’s saved answers. Questions the affiliate has not yet answered are returned with
answer: null. completed_at is null until the affiliate (or your integration) marks the onboarding complete.
Path Parameters
string
required
The unique identifier of the affiliate
Response
boolean
Always
true for successful responsesobject
Onboarding responses payload.
Show Data Object Properties
Show Data Object Properties
string
The active form’s ID
string
The active form’s name
string | null
The active form’s description, if set
string | null
ISO 8601 timestamp the affiliate completed onboarding, or
null when not completedarray
Active questions in display order, with the affiliate’s answer attached.
Show Question Properties
Show Question Properties
string
Question identifier
string
The question prompt
string
One of
single_choice, multiple_choice, text_input, textareaboolean
Whether the question is required
array
Available choices for choice-based questions
integer
0-based position in the form
string | array | null
The affiliate’s saved answer.
stringforsingle_choice,text_input, andtextareaarray of stringsformultiple_choicenullif the question has not been answered
curl -X GET "https://api.affonso.io/v1/affiliates/cmj8pptm10002p3010z8mk9ak/onboarding-responses" \
-H "Authorization: Bearer sk_live_your_api_key"
{
"success": true,
"data": {
"form_id": "cmf8onb0001p3010onbform1",
"form_name": "Affiliate Onboarding",
"form_description": "Tell us a bit about how you plan to promote our product.",
"completed_at": "2024-04-22T17:32:11.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,
"answer": ["Newsletter", "Blog"]
},
{
"id": "cmq1onb000onbq2",
"question": "Tell us about your audience",
"type": "textarea",
"is_required": false,
"options": [],
"order": 1,
"answer": "Mostly indie SaaS founders and bootstrapped teams."
}
]
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "No onboarding form configured for your team"
}
}
Notes
- Required permission:
read:affiliates. - Returns
404 NOT_FOUNDwithAffiliate not foundif the affiliate does not belong to your team. - Soft-deleted questions are excluded; previously stored answers for soft-deleted questions are not returned by this endpoint.
Was this page helpful?