---
title: "Get Retention Messaging Onboarding Status"
method: GET
path: "/v2/retention-onboarding/status"
tags: ["Retention Messaging Onboarding V2"]
---

# Get Retention Messaging Onboarding Status

`GET /v2/retention-onboarding/status`

## Query parameters

- `application_id` string, required — Application ID to inspect for retention messaging onboarding

## Response `200`

Success

- object
  - `object` 'retention_onboarding_status', required
  - `application_id` string, required — a string to be decoded into a number
  - `callback_url` string, required
  - `expected_realtime_url` string, required
  - `docs_url` string, required
  - `apple_access_url` string, required
  - `has_in_app_purchase_configuration` boolean, required
  - `has_app_store_connect_configuration` boolean, required
  - `has_app_store_app_id` boolean, required
  - `has_retention_rows` boolean, required

## Other responses

- `400` — The request did not match the expected schema
- `401` — No API key was provided in the request
- `403` — The API key does not have permission to perform this action
- `404` — The requested resource was not found
- `429` — Too many requests have been made in a short period
- `500` — An unexpected error occurred on the server

---

[API](https://skmtc.dev/superwall/apis/superwall-api-v2.md) · [All operations](https://skmtc.dev/superwall/apis/superwall-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/superwall/superwall-api-v2/revisions/e04f76c478af/schema)