iOS Builds API
The Builds API from iOS — 25 operation(s) for builds.
iOS Builds API is one of 199 APIs that iOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Builds. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and release notes.
This API exposes 30 operations across 25 paths, and defines 89 schemas. It is described by OpenAPI 3.0.1, at version 4.3.1.
Requests are made against a single base URL, https://api.appstoreconnect.apple.com/.
30 operations
25 paths
89 schemas
2 DELETE24 GET2 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
iOS Builds API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (itc-bearer-token).
By default, every request must be authenticated.
Paths & Operations 30
Across 25 paths, the API surfaces 30 operations — 2 DELETE, 24 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Builds 30
GET
/v1/builds
List Builds
GET
/v1/builds/{id}
Get Builds
PATCH
/v1/builds/{id}
Update Builds
GET
/v1/builds/{id}/relationships/app
Get Related Builds / App
GET
/v1/builds/{id}/app
Get Related Builds / App
GET
/v1/builds/{id}/relationships/appEncryptionDeclaration
Get Related Builds / App Encryption Declaration
PATCH
/v1/builds/{id}/relationships/appEncryptionDeclaration
Update Related Builds / App Encryption Declaration
GET
/v1/builds/{id}/appEncryptionDeclaration
Get Related Builds / App Encryption Declaration
GET
/v1/builds/{id}/relationships/appStoreVersion
Get Related Builds / App Store Version
GET
/v1/builds/{id}/appStoreVersion
Get Related Builds / App Store Version
GET
/v1/builds/{id}/relationships/betaAppReviewSubmission
Get Related Builds / Beta App Review Submission
GET
/v1/builds/{id}/betaAppReviewSubmission
Get Related Builds / Beta App Review Submission
GET
/v1/builds/{id}/relationships/betaBuildLocalizations
List Related Builds / Beta Build Localizations
GET
/v1/builds/{id}/betaBuildLocalizations
List Related Builds / Beta Build Localizations
POST
/v1/builds/{id}/relationships/betaGroups
Add Related Builds / Beta Groups
DELETE
/v1/builds/{id}/relationships/betaGroups
Remove Related Builds / Beta Groups
GET
/v1/builds/{id}/relationships/buildBetaDetail
Get Related Builds / Build Beta Detail
GET
/v1/builds/{id}/buildBetaDetail
Get Related Builds / Build Beta Detail
GET
/v1/builds/{id}/relationships/diagnosticSignatures
List Related Builds / Diagnostic Signatures
GET
/v1/builds/{id}/diagnosticSignatures
List Related Builds / Diagnostic Signatures
GET
/v1/builds/{id}/relationships/icons
List Related Builds / Icons
GET
/v1/builds/{id}/icons
List Related Builds / Icons
GET
/v1/builds/{id}/relationships/individualTesters
List Related Builds / Individual Testers
POST
/v1/builds/{id}/relationships/individualTesters
Add Related Builds / Individual Testers
DELETE
/v1/builds/{id}/relationships/individualTesters
Remove Related Builds / Individual Testers
GET
/v1/builds/{id}/individualTesters
List Related Builds / Individual Testers
GET
/v1/builds/{id}/perfPowerMetrics
List Related Builds / Perf Power Metrics
GET
/v1/builds/{id}/relationships/preReleaseVersion
Get Related Builds / Pre Release Version
GET
/v1/builds/{id}/preReleaseVersion
Get Related Builds / Pre Release Version
GET
/v1/builds/{id}/metrics/betaBuildUsages
Get Metrics Builds / Beta Build Usages
Schemas 89
The contract defines 89 schemas that model the data the API accepts and returns. The most detailed are MetricsInsight (9 properties), AppStoreVersionExperiment (5 properties), BetaGroup (5 properties), BetaAppReviewSubmission (5 properties). Each schema is shown below with its type and property counts.
BuildIndividualTestersLinkagesRequest
object
1 property
1 required
ErrorSourceParameter
object
1 property
1 required
BetaAppReviewSubmissionWithoutIncludesResponse
object
2 properties
2 required
AppVersionState
string
AppClipAction
string
DocumentLinks
object
1 property
1 required
BuildUpload
object
5 properties
2 required
AlternativeDistributionPackage
object
5 properties
2 required
BuildIcon
object
4 properties
2 required
BuildAppLinkageResponse
object
2 properties
2 required
PhasedReleaseState
string
AppStoreVersionPhasedRelease
object
4 properties
2 required
AppStoreVersionSubmission
object
4 properties
2 required
PrereleaseVersionWithoutIncludesResponse
object
2 properties
2 required
BuildUploadState
string
BuildBuildBetaDetailLinkageResponse
object
2 properties
2 required
BuildBetaAppReviewSubmissionLinkageResponse
object
2 properties
2 required
AppClipDefaultExperience
object
5 properties
2 required
AppWithoutIncludesResponse
object
2 properties
2 required
BetaReviewState
string
ExternalBetaState
string
ImageAsset
object
3 properties
PagedDocumentLinks
object
3 properties
1 required
BuildPreReleaseVersionLinkageResponse
object
2 properties
2 required
AppEncryptionDeclarationWithoutIncludesResponse
object
2 properties
2 required
xcodeMetrics
object
3 properties
AppEncryptionDeclarationState
string
BuildsResponse
object
4 properties
2 required
ErrorResponse
object
1 property
ChecksumAlgorithm
string
DiagnosticSignature
object
5 properties
2 required
BuildDiagnosticSignaturesLinkagesResponse
object
3 properties
2 required
ErrorSourcePointer
object
1 property
1 required
RoutingAppCoverage
object
5 properties
2 required
PagingInformation
object
1 property
1 required
BuildIconsLinkagesResponse
object
3 properties
2 required
BetaBuildLocalization
object
5 properties
2 required
GameCenterAppVersion
object
5 properties
2 required
BetaBuildUsagesV1MetricResponse
object
3 properties
2 required
BuildBetaDetailResponse
object
3 properties
2 required
BuildBundleType
string
DiagnosticInsightDirection
string
ErrorLinks
object
2 properties
AppMediaAssetState
object
3 properties
BetaTester
object
5 properties
2 required
BuildBetaDetail
object
5 properties
2 required
Platform
string
Checksums
object
2 properties
BuildResponse
object
3 properties
2 required
MetricCategory
string
AppStoreVersionExperiment
object
5 properties
2 required
DiagnosticInsight
object
3 properties
BuildUpdateRequest
object
1 property
1 required
App
object
5 properties
2 required
AppStoreReviewDetail
object
5 properties
2 required
RelationshipLinks
object
2 properties
BetaBuildLocalizationsWithoutIncludesResponse
object
3 properties
2 required
BuildAudienceType
string
BuildAppStoreVersionLinkageResponse
object
2 properties
2 required
MetricsInsight
object
9 properties
BetaGroup
object
5 properties
2 required
DiagnosticInsightType
string
HttpHeader
object
2 properties
BetaAppReviewSubmission
object
5 properties
2 required
ResourceLinks
object
1 property
BuildBetaGroupsLinkagesRequest
object
1 property
1 required
StateDetail
object
2 properties
UploadOperation
object
5 properties
PrereleaseVersion
object
5 properties
2 required
BetaTesterState
string
AppEncryptionDeclaration
object
5 properties
2 required
Build
object
5 properties
2 required
BuildAppEncryptionDeclarationLinkageResponse
object
2 properties
2 required
SubscriptionStatusUrlVersion
string
BetaTestersWithoutIncludesResponse
object
3 properties
2 required
AppStoreVersionLocalization
object
5 properties
2 required
BuildIconsWithoutIncludesResponse
object
3 properties
2 required
BetaInviteType
string
BuildBundle
object
5 properties
2 required
AppStoreVersion
object
5 properties
2 required
AppStoreVersionResponse
object
3 properties
2 required
DiagnosticSignaturesResponse
object
3 properties
2 required
InternalBetaState
string
IconAssetType
string
AppMediaStateError
object
2 properties
BuildIndividualTestersLinkagesResponse
object
3 properties
2 required
BuildAppEncryptionDeclarationLinkageRequest
object
1 property
1 required
AppStoreVersionState
string
BuildBetaBuildLocalizationsLinkagesResponse
object
3 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from iOS 12
Other APIs iOS publishes across the network.
App Store Server API
App Store Server Notifications
Apple Push Notification Service (APNs)
DeviceCheck and App Attest
Sign in with Apple REST API
Apple Music API
Wallet / PassKit Web Service
iOS AccessibilityDeclarations API
iOS Actors API
iOS AgeRatingDeclarations API
iOS AlternativeDistributionDomains API
iOS AlternativeDistributionKeys API
#Builds