---
title: "List onboardings"
method: GET
path: "/entities/{entity_id}/onboardings"
tags: ["Onboardings"]
---

# List onboardings

`GET /entities/{entity_id}/onboardings`

Lists the onboardings of the entity. Only onboardings belonging to the organization of the API key used are visible.

## Path parameters

- `entity_id` string, required

## Query parameters

- `ending_before` string
- `limit` integer
- `starting_after` string

## Response `200`

The list of onboardings of the entity, each as a compact object with its status and timestamps.

- object[]
  - `id` string, required — Unique identifier of the onboarding.
  - `object` string, required — Type of the object. Always `onboarding`.
  - `entity_id` string, required — Identifier of the entity this onboarding belongs to.
  - `status` 'pending' | 'in_progress' | 'submitted' | 'approved' | 'rejected' | 'cancelled', required — Current status of the onboarding. One of `pending`, `in_progress`, `submitted`, `approved`, `rejected`, or `cancelled`.
  - `source` 'api' | 'dashboard', required — Channel the onboarding is being completed through. One of `api` or `dashboard`.
  - `submitted_at` string, date-time, nullable, required — ISO 8601 datetime, in UTC, of when the onboarding was submitted for review. `null` until it is submitted.
  - `reviewed_at` string, date-time, nullable, required — ISO 8601 datetime, in UTC, of when the onboarding was reviewed. `null` until it is reviewed.

## Other responses

- `400` — Invalid request: `starting_after` and `ending_before` cannot be used at the same time.
- `401` — Invalid or missing API key.
- `404` — The entity does not exist, or belongs to another organization.

---

[API](https://skmtc.net/fintoc/apis/fintoc-api.md) · [All operations](https://skmtc.net/fintoc/apis/fintoc-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fintoc/fintoc-api/revisions/9dafa63688a3/schema)