Onboarding

List an onboarding flow's implementations

GET/onboarding/flows/{complianceId}/implementations
onboarding:readlist_compliance_implementationsRead-onlyDeprecatedSunset 2027-06-30

Cursor-paginated list of the flow's implementations, individual respondents' runs through it, newest first. ?q= searches respondents by name. Optionally filter by the expired and flow_test flags and a started_from/started_to date range. Deprecated: withdrawn on 2027-06-30. GET /onboarding-sessions?filter[flow_id]={complianceId} replaces it; the Link header names it.

Path parameters

  • complianceIdstring (uuid)Required#

    The compliance flow's public uuid.

Query parameters

  • limitinteger#

    Page size (1–100). Defaults to 25; values are clamped to the range.

    Default: 25
  • cursorstring#

    Opaque pagination cursor taken from a prior response's meta.next_cursor.

  • qstring#

    Free-text search on the respondent.

  • expiredboolean#

    Filter to implementations whose expired flag matches this value.

  • flow_testboolean#

    Filter to implementations whose flow_test (dry-run) flag matches this value.

  • started_fromstring (date)#

    Only implementations with a start date on or after this date (inclusive).

  • started_tostring (date)#

    Only implementations with a start date on or before this date (inclusive).

Responses

200

OK

{
  "data": [
    {
      "id": "1f0c9e8d-7b6a-4039-8271-6e5d4c3b2a19",
      "compliance_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
      "user_id": "a1b2c3d4-e5f6-4071-8293-a4b5c6d7e8f9",
      "flow_test": false,
      "expired": false,
      "start_date": "2026-06-15T10:30:00+00:00",
      "end_date": "2026-06-15T10:45:00+00:00",
      "created_at": "2026-06-15T10:30:00+00:00",
      "updated_at": "2026-06-15T10:45:00+00:00"
    }
  ],
  "links": {
    "first": null,
    "last": null,
    "prev": null,
    "next": null
  },
  "meta": {
    "path": "https://your-org-domain/kong/core/api/v2/onboarding/flows/9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d/implementations",
    "per_page": 25,
    "next_cursor": null,
    "prev_cursor": null
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

Request validation failed (HTTP 422). The body is either the Laravel validation envelope (message + field-keyed errors) or the API error envelope for domain rejections (e.g. form_type_not_supported, folder_locked, parent_not_found, folder_not_empty).

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/onboarding/flows/{complianceId}/implementations\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"