Get TestFlight page configuration

GET /api/apps/{appId}/testflight-page

Parameters

appIdrequired string The app's unique identifier Example: -NtestApp123

Responses

enabledrequired boolean Whether the TestFlight page is active

testFlightUrlrequired string TestFlight invite URL (https://testflight.apple.com/join/XXXXXX) Pattern: TestFlight invite URL

betaDescription string What testers should test Max 2000 characters

requirements string Device/OS requirements (e.g., iOS 17.0+, iPhone only) Max 500 characters

feedbackEmailrequired string (email) Contact email for tester feedback Max 320 characters

updatedAt integer Unix timestamp (ms) of last update

errorrequired object

coderequired string Machine-readable error code UNAUTHORIZEDFORBIDDENNOT_FOUNDVALIDATION_FAILEDRATE_LIMITEDSLUG_TAKENSLUG_RESERVEDDOMAIN_IN_USEAPP_LIMIT_REACHEDSUBSCRIPTION_REQUIREDSUBSCRIPTION_EXISTSNO_PAYMENT_METHODNO_ACTIVE_SUBSCRIPTIONNOT_CANCELINGALREADY_CANCELINGSUBSCRIPTION_CANCELINGSAME_PLANCARD_ERRORPAYMENT_ERRORNO_STRIPE_CUSTOMERCERT_CREATION_FAILEDDEPLOY_FAILEDAPI_KEY_LIMIT_REACHEDINVALID_IDEMPOTENCY_KEYIDEMPOTENCY_KEY_REUSEINTERNAL_ERROR

messagerequired string Human-readable error description

docUrl string (uri) Link to relevant API documentation for this error Example: https://orbitkit.io/api/errors/#unauthorized

details object[] Additional validation details (Zod errors)

errorrequired object

messagerequired string Human-readable error description

docUrl string (uri) Link to relevant API documentation for this error Example: https://orbitkit.io/api/errors/#unauthorized

details object[] Additional validation details (Zod errors)

Language

URL

GET https://api.orbitkit.io/api/apps/{appId}/testflight-page

curl -X GET "https://api.orbitkit.io/api/apps/-NtestApp123/testflight-page" \
  -H "Authorization: Bearer $ORBITKIT_API_KEY"

const response = await fetch(`https://api.orbitkit.io/api/apps/-NtestApp123/testflight-page`, {
  method: "GET",
  headers: {
    "Authorization": "Bearer " + apiKey,
  },
});

const data = await response.json();
console.log(data);

var request = URLRequest(url: URL(string: "https://api.orbitkit.io/api/apps/-NtestApp123/testflight-page")!)
request.httpMethod = "GET"
request.setValue("Bearer \(apiKey)", forHTTPHeaderField: "Authorization")

let (data, _) = try await URLSession.shared.data(for: request)
let json = try JSONSerialization.jsonObject(with: data)
print(json)

200

{
  "enabled": true,
  "testFlightUrl": "https://example.com",
  "betaDescription": "string",
  "requirements": "string",
  "feedbackEmail": "user@example.com",
  "updatedAt": 0
}

401

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or expired token",
    "docUrl": "https://orbitkit.io/api/errors/#unauthorized"
  }
}

404

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "docUrl": "https://orbitkit.io/api/errors/#not-found"
  }
}