Onboarding

List onboarding forms

List onboarding forms.

GET

/agency/onboarding_forms

curl --request GET \
  --url 'https://api-example.kickcall.ai/api/v1/agency/onboarding_forms?page=1&per_page=25' \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "business_name": "New Clinic",
      "id": 61,
      "status": "pending"
    }
  ],
  "links": {
    "first": "https://api-example.kickcall.ai/api/v1/...?...&page=1",
    "last": "https://api-example.kickcall.ai/api/v1/...?...&page=1",
    "next": null,
    "prev": null,
    "self": "https://api-example.kickcall.ai/api/v1/...?...&page=1"
  },
  "meta": {
    "count": 1,
    "total_count": 1,
    "total_pages": 1
  }
}

Audience: Agency portal. Auth: Agency JWT or agency API key (Authorization: Bearer or X-Api-Key). Resource: Onboarding.

Authorizations

Authorizationstringheaderrequired

JWT from OTP login, or business/agency API key string.

Query Parameters

pageintegerquerydefault:1

Required range: 1 <= x

per_pageintegerquerydefault:25

Required range: 1 <= x <= 100

Response

OK — Onboarding forms

bodyobject

Still need help? Ask the team