v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-012382333.4 MB

List Entity Onboarding Session

get/entity_onboarding_sessions

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

status.instring[]

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_keystring

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.

Response

Entity Onboarding Session List

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

Example response

{
  "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"
}