---
title: "List Entity Onboarding Session"
method: GET
path: "/entity_onboarding_sessions"
---

# List Entity Onboarding Session

`GET /entity_onboarding_sessions`

## Query parameters

- `cursor` string — Return the page of entries after this one.
- `limit` integer — Limit the size of the list that is returned. The default (and maximum) is 100 objects.
- `status.in` string[] — Filter Entity Onboarding Session for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
- `idempotency_key` string — Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).

## Response `200`

Entity Onboarding Session List

- EntityOnboardingSessionList — A list of Entity Onboarding Session objects.
  - `data` EntityOnboardingSession[], required — The contents of the list.
    - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Entity Onboarding Session was created.
    - `entity_id` string, nullable, required — The identifier of the Entity associated with this session, if one has been created or was provided when creating the session.
    - `expires_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Entity Onboarding Session will expire.
    - `id` string, required — The Entity Onboarding Session's identifier.
    - `idempotency_key` string, nullable, required — The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
    - `program_id` string, required — The identifier of the Program the Entity will be onboarded to.
    - `redirect_url` string, required — The URL to redirect to after the onboarding session is complete. Increase will include the query parameters `entity_onboarding_session_id` and `entity_id` when redirecting.
    - `session_url` string, nullable, required — The URL containing the onboarding form. You should share this link with your customer. Only present when the session is active.
    - `status` 'active' | 'expired', required — The status of the onboarding session.
    - `type` 'entity_onboarding_session', required — A constant representing the object's type. For this resource it will always be `entity_onboarding_session`.
  - `next_cursor` string, nullable, required — A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.

## Other responses

- `4XX` — Error
- `5XX` — Error

---

[API](https://skmtc.net/increase/apis/increase-api.md) · [All operations](https://skmtc.net/increase/apis/increase-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/increase/increase-api/versions/22125d715935/schema)