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

​
success
boolean
Always true for successful responses
​
data
object
The onboarding form object.
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
      }
    ]
  }
}

​
Notes

  • Only questions with status: true are returned. Soft-deleted questions are excluded.
  • Each team has at most one onboarding form. To modify it, use PATCH /v1/onboarding-form.