---
title: "Get Migration Cohort"
method: GET
path: "/iap/migration-cohort/"
tags: ["Migration"]
---

# Get Migration Cohort

`GET /iap/migration-cohort/`

## Request

- Base URL: `https://api.zerosettle.io/v1`
- URL: `https://api.zerosettle.io/v1/iap/migration-cohort/`
- Auth: API key in header `X-ZeroSettle-Key`

Server-to-server. Lists the users who are currently eligible for your Switch & Save offer, so your backend can target them (for example with email or push). Authenticate with your **secret** key, never the publishable key. The environment (sandbox or live) comes from the key. This is an enumeration: it does not count impressions. Eligibility follows the same rules as the offer the SDK shows. When no campaign is enabled the list is empty.

## Query parameters

- `cursor` string
- `limit` integer

## Response `200`

A page of eligible users

- object
  - `users` object[], required
    - `external_user_id` string: The user ID your app passed to `identify`.
    - `product_id` string: The product the user subscribes to.
    - `subscription_started_at` string, date-time: When the subscription started.
    - `eligible_since` string, date-time: When the user became eligible: the start plus the campaign minimum subscription days.
    - `is_currently_eligible` boolean: Always `true`: only eligible users are listed.
  - `next_cursor` string, nullable, required: Pass as `cursor` to get the next page. Null on the last page. A page can hold fewer users than `limit` only on the last page.
  - `campaign` object, required
    - `is_enabled` boolean: Whether the Switch & Save campaign is enabled.
    - `rollout_percent` integer: Percentage of eligible users the campaign rolls out to.

## Other responses

- `400`: `Invalid cursor`.
- `401`: The `X-ZeroSettle-Key` header is missing, or the key is not a valid secret key (`Invalid secret key`). A publishable key is rejected.

## Changes

- **2026-10-26** `e5968a6bc8f7`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zerosettle/apis/zerosettle-iap-api/changes/iap/migration-cohort/get.md)

---

[API](https://skmtc.dev/zerosettle/apis/zerosettle-iap-api.md) - [All operations](https://skmtc.dev/zerosettle/apis/zerosettle-iap-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zerosettle/apis/zerosettle-iap-api/revisions/4cd9e227d9b8?raw)