iOS

iOS App Events API

The App Events API from iOS — 4 operation(s) for app events.

GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/appEvents Create an in-app event · Create App Events #
Ask an LLM
“How do I create an in-app event to feature on the App Store?”
“Can I schedule a new in-app event like a challenge or live event through the API?”
Tell an agent
Create an in-app event with {event}.
Set up a new App Store in-app event for my app using {event}.
GET /v1/appEvents/{id} Get an in-app event · Get App Events #
Ask an LLM
“What are the dates, badge and status of one in-app event?”
“Can I fetch an in-app event along with its localizations?”
Tell an agent
Get in-app event {event}.
Fetch in-app event {event} and include {include}.
PATCH /v1/appEvents/{id} Update an in-app event · Update App Events #
Ask an LLM
“How do I change the schedule or badge of an existing in-app event?”
“Can I edit an in-app event's details after it's created?”
Tell an agent
Update in-app event {event} with {changes}.
Reschedule App Store event {event} using {changes}.
DELETE /v1/appEvents/{id} Delete an in-app event · Delete App Events #
Ask an LLM
“How do I delete an in-app event I don't want to run?”
“Can I remove an in-app event from my app entirely?”
Tell an agent destructive · confirm first
Delete in-app event {event}.
Remove the App Store event {event} from my app.
GET /v1/appEvents/{id}/relationships/localizations List localization IDs for an in-app event · List Related App Events / Localizations #
Ask an LLM
“Which localization IDs exist for an in-app event?”
“Can I get only the identifiers of an event's translated versions?”
Tell an agent
List only the localization IDs for in-app event {event}.
Return up to {limit} localization identifiers for event {event}.
GET /v1/appEvents/{id}/localizations List an in-app event's localized text and media · List Related App Events / Localizations #
Ask an LLM
“What names and descriptions have I written for an in-app event in each language?”
“Can I see an event's localizations with their screenshots and video clips?”
Tell an agent
Show the full localizations for in-app event {event}.
Fetch the translated copy for event {event} and include {include}.

Documentation

📖
Documentation
https://developer.apple.com/documentation/appstoreconnectapi
📖
APIReference
https://developer.apple.com/documentation/appstoreconnectapi
📖
GettingStarted
https://developer.apple.com/documentation/appstoreconnectapi/creating-api-keys-for-app-store-connect-api
📖
Authentication
https://developer.apple.com/documentation/appstoreconnectapi/generating-tokens-for-api-requests

Specifications

⚙
OpenAPI
https://artifacts.apis.io/ios/openapi/ios-app-events-api-openapi.yml

Other Resources

🔗
ReleaseNotes
https://developer.apple.com/documentation/appstoreconnectapi/app-store-connect-api-release-notes
🔗
SDKs
https://github.com/apple/app-store-server-library-swift
🔗
SDKs
https://github.com/apple/app-store-server-library-java
🔗
SDKs
https://github.com/apple/app-store-server-library-python
🔗
SDKs
https://github.com/apple/app-store-server-library-node

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ios:ios-app-events-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ios-app-events-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: App Store Connect App Events API
  version: 4.3.1
  x-platforms:
    app_store_connect_api: App Store Connect API
  description: The App Store Connect API is the standards-based REST API Apple provides to automate tasks across App Store Connect, Xcode, and Certificates, Identifiers & Profiles.
servers:
- url: https://api.appstoreconnect.apple.com/
security:
- itc-bearer-token: []
tags:


# --- truncated at 32 KB (35 KB total) ---
# Full source: https://artifacts.apis.io/ios/openapi/ios-app-events-api-openapi.yml