Skip to main content
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."
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.affonso.io/llms.txt

Use this file to discover all available pages before exploring further.

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

​
id
string
required
The unique identifier of the affiliate

​
Response

​
success
boolean
Always true for successful responses
​
data
object
Onboarding responses payload.
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."
      }
    ]
  }
}

​
Notes

  • Required permission: read:affiliates.
  • Returns 404 NOT_FOUND with Affiliate not found if 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.