Onboarding Sessions

Export onboarding sessions

POST/onboarding-sessions/exports
onboarding:readexport_onboarding_sessions

Starts a CSV export of the sessions GET /onboarding-sessions would return and answers 202 with the job. The filter must name a flow_id or user_id, else 422. Columns are the session's fields; verification is written as JSON. The body takes filter and sort as the list does, and only sessions the token can read are written. Poll GET /jobs/{id}; when it succeeds, result.download_url gives the file for 7 days. No session changes, webhook or email; nothing needs undoing.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, optional

  • filterobject#

    The filters of the list, written as in GET /onboarding-sessions, such as { "flow_id": "…" }. Operators nest the same way, such as { "started_at": { "gte": "2026-10-01" } }.

  • sortstring#

    Comma-separated fields to sort by, as on the list. Prefix a field with - for descending.

  • formatstring#

    The file format. Only csv is offered, and it is the default.

    One of: csv
{
  "filter": {
    "flow_id": "48e0c1a6-6f3b-4d44-9d49-0a5a0b8f2d11",
    "status": "completed"
  }
}

Responses

202

The export job was started.

Job
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "type": "string",
    "status": "queued",
    "progress": {
      "done": 1,
      "total": 1
    },
    "result": {},
    "error": {},
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00",
    "completed_at": "2026-06-12T10:00:00+00:00"
  }
}
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
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/onboarding-sessions/exports\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "filter": {
    "flow_id": "48e0c1a6-6f3b-4d44-9d49-0a5a0b8f2d11",
    "status": "completed"
  }
}'