iOS · Schema

App

An App resource in the App Store Connect API. Represents an iOS / iPadOS / watchOS / tvOS / visionOS / macOS app the team has registered. JSON:API typed resource.

iOSAppleMobileApp StorePush NotificationsIn-App PurchasesSubscriptionsAuthenticationWalletDeveloper Platform

Properties

Name Type Description
type object
id string Apple App ID (numeric string).
attributes object
relationships object
links object
View JSON Schema on GitHub

JSON Schema

app-store-connect-app-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ios/main/json-schema/app-store-connect-app-schema.json",
  "title": "App",
  "description": "An App resource in the App Store Connect API. Represents an iOS / iPadOS / watchOS / tvOS / visionOS / macOS app the team has registered. JSON:API typed resource.",
  "type": "object",
  "required": ["type", "id"],
  "properties": {
    "type": { "const": "apps" },
    "id": { "type": "string", "description": "Apple App ID (numeric string)." },
    "attributes": {
      "type": "object",
      "properties": {
        "name": { "type": "string" },
        "bundleId": { "type": "string" },
        "sku": { "type": "string" },
        "primaryLocale": { "type": "string" },
        "isOrEverWasMadeForKids": { "type": "boolean" },
        "subscriptionStatusUrl": { "type": "string", "format": "uri" },
        "subscriptionStatusUrlVersion": {
          "type": "string",
          "enum": ["V1", "V2"]
        },
        "contentRightsDeclaration": {
          "type": "string",
          "enum": ["DOES_NOT_USE_THIRD_PARTY_CONTENT", "USES_THIRD_PARTY_CONTENT"]
        },
        "streamlinedPurchasingEnabled": { "type": "boolean" }
      }
    },
    "relationships": {
      "type": "object",
      "additionalProperties": true
    },
    "links": {
      "type": "object",
      "properties": {
        "self": { "type": "string", "format": "uri" }
      }
    }
  }
}