GET
/apps/{appId}/versionsList app versions
Returns all app versions including released and unreleased versions, ordered by most recent creation date.
Parameters
appIdpathrequiredPOST
/apps/{appId}/versionsCreate version
Creates a new app version in App Store Connect and initiates a background sync to the local database.
Parameters
appIdpathrequiredRequest Body
Bodyapplication/json
| Field | Type | Notes |
|---|---|---|
versionString | string | required |
GET
/apps/{appId}/versions/{version}/metadataGet version metadata
Returns complete metadata for a version including descriptions, release notes, and keywords for all locales.
Parameters
appIdpathrequiredversionpathrequiredPUT
/apps/{appId}/versions/{version}/metadataUpdate version metadata
Updates metadata for a version with support for partial updates of localizations and version number.
Parameters
appIdpathrequiredversionpathrequiredRequest Body
Bodyapplication/json
| Field | Type | Notes |
|---|---|---|
metadata | object | |
localizations[] | array<object> | required |
id | string | |
locale | string | required |
appleLocalizationId | any | |
appleDescription | any | |
appleReleaseNotes | any | |
appleKeywords | any | |
versionNumber | string |
GET
/apps/{appId}/versions/{version}/screenshotsGet version screenshots
Returns all screenshot sets for a version including device types and image metadata.
Parameters
appIdpathrequiredversionpathrequiredPOST
/apps/{appId}/versions/{version}/screenshotsCreate screenshot set
Creates a new screenshot set for a version with the specified device type.
Parameters
appIdpathrequiredversionpathrequiredRequest Body
Bodyapplication/json
| Field | Type | Notes |
|---|---|---|
deviceType | string | required enum: APP_IPHONE_67 | APP_IPHONE_61 | APP_IPHONE_65 | APP_IPHONE_58 | APP_IPHONE_55 | APP_IPHONE_47 | APP_IPHONE_40 | APP_IPHONE_35 | APP_IPAD_PRO_3GEN_129 | APP_IPAD_PRO_3GEN_11 | APP_IPAD_PRO_129 | APP_IPAD_105 | APP_IPAD_97 | APP_DESKTOP | APP_WATCH_ULTRA | APP_WATCH_SERIES_10 | APP_WATCH_SERIES_7 | APP_WATCH_SERIES_4 | APP_WATCH_SERIES_3 | APP_APPLE_TV | APP_APPLE_VISION_PRO | IMESSAGE_APP_IPHONE_67 | IMESSAGE_APP_IPHONE_61 | IMESSAGE_APP_IPHONE_65 | IMESSAGE_APP_IPHONE_58 | IMESSAGE_APP_IPHONE_55 | IMESSAGE_APP_IPHONE_47 | IMESSAGE_APP_IPHONE_40 | IMESSAGE_APP_IPAD_PRO_3GEN_129 | IMESSAGE_APP_IPAD_PRO_3GEN_11 | IMESSAGE_APP_IPAD_PRO_129 | IMESSAGE_APP_IPAD_105 | IMESSAGE_APP_IPAD_97 |
DELETE
/apps/{appId}/versions/{version}/screenshotsDelete screenshot set
Deletes a screenshot set for a version based on the specified device type.
Parameters
appIdpathrequiredversionpathrequireddeviceTypequeryrequiredGET
/apps/{appId}/versions/{version}Get version details
Returns detailed information for a version including version number, build details, creation date, and status.
Parameters
appIdpathrequiredversionpathrequiredPOST
/apps/{appId}/versions/{version}/link-buildLink build to version
Links a build to a version and initiates a background task to push the change to App Store Connect.
Parameters
appIdpathrequiredversionpathrequiredRequest Body
Bodyapplication/json
| Field | Type | Notes |
|---|---|---|
buildId | string | required |