List entity onboarding sessions

4 parameters

cursorstringoptional

Returns the page of entity onboarding sessions after this cursor.

limitintegeroptional

Maximum number of sessions to return. Must be between 1 and 100. Defaults to 100 when omitted.

Default:100

status.inarray<string>optional

Filter sessions by status; provide `active`, `expired`, or both as a comma-delimited list.

idempotency_keystringoptional

Filter for the session with this idempotency key. Must be between 1 and 200 characters.

3 status codes

200Returns a page of entity onboarding session objects and a `next_cursor` for retrieving the next page.

dataarray<EntityOnboardingSession>required

The contents of the list.

next_cursorstringrequired

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`.

4XXReturned when the request has a client-side error.

5XXReturned when the request encounters a server-side error.

Error handling

limit must be between 1 and 100, and status.in accepts active or expired. idempotency_key must be between 1 and 200 characters when provided.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
});

const result = await client.entityOnboardingSessions.list({
  cursor: "example",
  limit: 20,
  statusIn: "example",
  idempotencyKey: "example",
});

{
  "data": [
    {
      "created_at": "2020-01-31T23:59:59Z",
      "entity_id": "entity_n8y8tnk2p9339ti393yi",
      "expires_at": "2020-02-01T05:59:59+00:00",
      "id": "entity_onboarding_session_wid2ug11fsmvh3k9hymd",
      "idempotency_key": null,
      "program_id": "program_i2v2os4mwza1oetokh9i",
      "redirect_url": "https://example.com/onboarding/completed",
      "session_url": "https://onboarding.increase.com/onboarding/sessions?id=HIrdj46cXyyNqT5RDcIR38dzPqzRBgTdG84XwzOz",
      "status": "active",
      "type": "entity_onboarding_session"
    }
  ],
  "next_cursor": "v57w5d"
}

Request

Response

Errors