How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, 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.

Specification
OpenAPI 3.2.0
API Version
4.3.1
Base URL
https://api.appstoreconnect.apple.com
Authentication
HTTP Bearer
Resource Areas
1

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
builds_getCollection 35 params → 400401403200429
GET
/v1/builds/{id}
Get Builds
builds_getInstance 20 params → 400401403404200429
PATCH
/v1/builds/{id}
Update Builds
builds_updateInstance 1 param body → 400401403404422200409429
GET
/v1/builds/{id}/relationships/app
Get Related Builds / App
builds_app_getToOneRelationship 1 param → 400401403404200429
GET
/v1/builds/{id}/app
Get Related Builds / App
builds_app_getToOneRelated 2 params → 400401403404200429
GET
/v1/builds/{id}/relationships/appEncryptionDeclaration
Get Related Builds / App Encryption Declaration
builds_appEncryptionDeclaration_getToOneRelationship 1 param → 400401403404200429
PATCH
/v1/builds/{id}/relationships/appEncryptionDeclaration
Update Related Builds / App Encryption Declaration
builds_appEncryptionDeclaration_updateToOneRelationship 1 param body → 400401403404422409204429
GET
/v1/builds/{id}/appEncryptionDeclaration
Get Related Builds / App Encryption Declaration
builds_appEncryptionDeclaration_getToOneRelated 2 params → 400401403404200429
GET
/v1/builds/{id}/relationships/appStoreVersion
Get Related Builds / App Store Version
builds_appStoreVersion_getToOneRelationship 1 param → 400401403404200429
GET
/v1/builds/{id}/appStoreVersion
Get Related Builds / App Store Version
builds_appStoreVersion_getToOneRelated 17 params → 400401403404200429
GET
/v1/builds/{id}/relationships/betaAppReviewSubmission
Get Related Builds / Beta App Review Submission
builds_betaAppReviewSubmission_getToOneRelationship 1 param → 400401403404200429
GET
/v1/builds/{id}/betaAppReviewSubmission
Get Related Builds / Beta App Review Submission
builds_betaAppReviewSubmission_getToOneRelated 2 params → 400401403404200429
GET
/v1/builds/{id}/relationships/betaBuildLocalizations
List Related Builds / Beta Build Localizations
builds_betaBuildLocalizations_getToManyRelationship 2 params → 400401403404200429
GET
/v1/builds/{id}/betaBuildLocalizations
List Related Builds / Beta Build Localizations
builds_betaBuildLocalizations_getToManyRelated 3 params → 400401403404200429
POST
/v1/builds/{id}/relationships/betaGroups
Add Related Builds / Beta Groups
builds_betaGroups_createToManyRelationship 1 param body → 400401403404422409204429
DELETE
/v1/builds/{id}/relationships/betaGroups
Remove Related Builds / Beta Groups
builds_betaGroups_deleteToManyRelationship 1 param body → 400401403404422409204429
GET
/v1/builds/{id}/relationships/buildBetaDetail
Get Related Builds / Build Beta Detail
builds_buildBetaDetail_getToOneRelationship 1 param → 400401403404200429
GET
/v1/builds/{id}/buildBetaDetail
Get Related Builds / Build Beta Detail
builds_buildBetaDetail_getToOneRelated 4 params → 400401403404200429
GET
/v1/builds/{id}/relationships/diagnosticSignatures
List Related Builds / Diagnostic Signatures
builds_diagnosticSignatures_getToManyRelationship 2 params → 400401403404200429
GET
/v1/builds/{id}/diagnosticSignatures
List Related Builds / Diagnostic Signatures
builds_diagnosticSignatures_getToManyRelated 4 params → 400401403404200429
GET
/v1/builds/{id}/relationships/icons
List Related Builds / Icons
builds_icons_getToManyRelationship 2 params → 400401403404200429
GET
/v1/builds/{id}/icons
List Related Builds / Icons
builds_icons_getToManyRelated 3 params → 400401403404200429
GET
/v1/builds/{id}/relationships/individualTesters
List Related Builds / Individual Testers
builds_individualTesters_getToManyRelationship 2 params → 400401403404200429
POST
/v1/builds/{id}/relationships/individualTesters
Add Related Builds / Individual Testers
builds_individualTesters_createToManyRelationship 1 param body → 400401403404422409204429
DELETE
/v1/builds/{id}/relationships/individualTesters
Remove Related Builds / Individual Testers
builds_individualTesters_deleteToManyRelationship 1 param body → 400401403404422409204429
GET
/v1/builds/{id}/individualTesters
List Related Builds / Individual Testers
builds_individualTesters_getToManyRelated 3 params → 400401403404200429
GET
/v1/builds/{id}/perfPowerMetrics
List Related Builds / Perf Power Metrics
builds_perfPowerMetrics_getToManyRelated 4 params → 400401403404200429
GET
/v1/builds/{id}/relationships/preReleaseVersion
Get Related Builds / Pre Release Version
builds_preReleaseVersion_getToOneRelationship 1 param → 400401403404200429
GET
/v1/builds/{id}/preReleaseVersion
Get Related Builds / Pre Release Version
builds_preReleaseVersion_getToOneRelated 2 params → 400401403404200429
GET
/v1/builds/{id}/metrics/betaBuildUsages
Get Metrics Builds / Beta Build Usages
builds_betaBuildUsages_getMetrics 2 params → 400401403404200429

Schemas 89

The contract defines 89 schemas that model the data the API accepts and returns. The most detailed are MetricsInsight (9 properties), AppClipDefaultExperience (5 properties), App (5 properties), RoutingAppCoverage (5 properties). Each schema is shown below with its type and property counts.

AppEncryptionDeclarationWithoutIncludesResponse
object
2 properties 2 required
AppStoreVersionSubmission
object
4 properties 2 required
InternalBetaState
string
AppWithoutIncludesResponse
object
2 properties 2 required
ChecksumAlgorithm
string
SubscriptionStatusUrlVersion
string
BuildIndividualTestersLinkagesRequest
object
1 property 1 required
DiagnosticInsightDirection
string
AppEncryptionDeclarationState
string
StateDetail
object
2 properties
AppVersionState
string
BuildAppEncryptionDeclarationLinkageResponse
object
2 properties 2 required
AppMediaAssetState
object
3 properties
BetaBuildUsagesV1MetricResponse
object
3 properties 2 required
ResourceLinks
object
1 property
BetaBuildLocalization
object
5 properties 2 required
AppStoreVersionPhasedRelease
object
4 properties 2 required
HttpHeader
object
2 properties
IconAssetType
string
BuildPreReleaseVersionLinkageResponse
object
2 properties 2 required
AppStoreVersionResponse
object
3 properties 2 required
BuildsResponse
object
4 properties 2 required
ErrorLinks
object
2 properties
PrereleaseVersionWithoutIncludesResponse
object
2 properties 2 required
ErrorSourcePointer
object
1 property 1 required
MetricsInsight
object
9 properties
AppStoreReviewDetail
object
5 properties 2 required
BuildUploadState
string
DiagnosticSignaturesResponse
object
3 properties 2 required
BuildAppStoreVersionLinkageResponse
object
2 properties 2 required
xcodeMetrics
object
3 properties
AppClipDefaultExperience
object
5 properties 2 required
BuildDiagnosticSignaturesLinkagesResponse
object
3 properties 2 required
BuildAppLinkageResponse
object
2 properties 2 required
ImageAsset
object
3 properties
AppStoreVersionExperiment
object
5 properties 2 required
BuildIndividualTestersLinkagesResponse
object
3 properties 2 required
BetaGroup
object
5 properties 2 required
AlternativeDistributionPackage
object
5 properties 2 required
BetaTester
object
5 properties 2 required
PrereleaseVersion
object
5 properties 2 required
BuildBetaAppReviewSubmissionLinkageResponse
object
2 properties 2 required
PhasedReleaseState
string
DiagnosticSignature
object
5 properties 2 required
BuildAppEncryptionDeclarationLinkageRequest
object
1 property 1 required
ErrorSourceParameter
object
1 property 1 required
AppEncryptionDeclaration
object
5 properties 2 required
BetaTestersWithoutIncludesResponse
object
3 properties 2 required
BetaAppReviewSubmission
object
5 properties 2 required
UploadOperation
object
5 properties
BetaReviewState
string
BetaAppReviewSubmissionWithoutIncludesResponse
object
2 properties 2 required
MetricCategory
string
BuildUpload
object
5 properties 2 required
BuildAudienceType
string
BuildBetaDetailResponse
object
3 properties 2 required
RelationshipLinks
object
2 properties
ExternalBetaState
string
Checksums
object
2 properties
RoutingAppCoverage
object
5 properties 2 required
App
object
5 properties 2 required
DiagnosticInsightType
string
BuildBetaBuildLocalizationsLinkagesResponse
object
3 properties 2 required
BetaTesterState
string
BuildBetaDetail
object
5 properties 2 required
AppMediaStateError
object
2 properties
GameCenterAppVersion
object
5 properties 2 required
AppClipAction
string
BuildBundleType
string
BuildResponse
object
3 properties 2 required
DiagnosticInsight
object
3 properties
BuildIconsWithoutIncludesResponse
object
3 properties 2 required
ErrorResponse
object
1 property
BuildIconsLinkagesResponse
object
3 properties 2 required
AppStoreVersion
object
5 properties 2 required
DocumentLinks
object
1 property 1 required
AppStoreVersionState
string
BuildIcon
object
4 properties 2 required
BuildUpdateRequest
object
1 property 1 required
BuildBuildBetaDetailLinkageResponse
object
2 properties 2 required
Platform
string
BetaBuildLocalizationsWithoutIncludesResponse
object
3 properties 2 required
PagedDocumentLinks
object
3 properties 1 required
BuildBundle
object
5 properties 2 required
BuildBetaGroupsLinkagesRequest
object
1 property 1 required
BetaInviteType
string
PagingInformation
object
1 property 1 required
Build
object
5 properties 2 required
AppStoreVersionLocalization
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ios-builds-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of iOS Builds API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.