iOS
iOS Builds API

The Builds API from iOS — 25 operation(s) for builds.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.1
info:
  title: App Store Connect AccessibilityDeclarations Builds 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. It covers apps, builds, TestFlight, in-app purchases, subscriptions, Game Center, Xcode Cloud, provisioning, pricing and availability, and the full reporting surface (analytics, sales and trends, financial reports, power and performance). This spec is the official OpenAPI 3.0 document published by Apple at https://developer.apple.com/app-store-connect/api/ — mirrored here unmodified except for title-cased operation summaries.
servers:
- url: https://api.appstoreconnect.apple.com/
security:
- itc-bearer-token: []
tags:
- name: Builds
paths:
  /v1/builds:
    get:
      tags:
      - Builds
      operationId: builds_getCollection
      parameters:
      - name: filter[version]
        in: query
        description: filter by attribute 'version'
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
        required: false
      - name: filter[expired]
        in: query
        description: filter by attribute 'expired'
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
        required: false
      - name: filter[processingState]
        in: query
        description: filter by attribute 'processingState'
        schema:
          type: array
          items:
            type: string
            enum:
            - PROCESSING
            - FAILED
            - INVALID
            - VALID
        style: form
        explode: false
        required: false
      - name: filter[betaAppReviewSubmission.betaReviewState]
        in: query
        description: filter by attribute 'betaAppReviewSubmission.betaReviewState'
        schema:
          type: array
          items:
            type: string
            enum:
            - WAITING_FOR_REVIEW
            - IN_REVIEW
            - REJECTED
            - APPROVED
        style: form
        explode: false
        required: false
      - name: filter[usesNonExemptEncryption]
        in: query
        description: filter by attribute 'usesNonExemptEncryption'
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
        required: false
      - name: filter[preReleaseVersion.version]
        in: query
        description: filter by attribute 'preReleaseVersion.version'
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
        required: false
      - name: filter[preReleaseVersion.platform]
        in: query
        description: filter by attribute 'preReleaseVersion.platform'
        schema:
          type: array
          items:
            type: string
            enum:
            - IOS
            - MAC_OS
            - TV_OS
            - VISION_OS
        style: form
        explode: false
        required: false
      - name: filter[buildAudienceType]
        in: query
        description: filter by attribute 'buildAudienceType'
        schema:
          type: array
          items:
            type: string
            enum:
            - INTERNAL_ONLY
            - APP_STORE_ELIGIBLE
        style: form
        explode: false
        required: false
      - name: filter[preReleaseVersion]
        in: query
        description: filter by id(s) of related 'preReleaseVersion'
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
        required: false
      - name: filter[app]
        in: query
        description: filter by id(s) of related 'app'
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
        required: false
      - name: filter[betaGroups]
        in: query
        description: filter by id(s) of related 'betaGroups'
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
        required: false
      - name: filter[appStoreVersion]
        in: query
        description: filter by id(s) of related 'appStoreVersion'
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
        required: false
      - name: filter[id]
        in: query
        description: filter by id(s)
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
        required: false
      - name: exists[usesNonExemptEncryption]
        in: query
        description: filter by attribute 'usesNonExemptEncryption'
        schema:
          type: boolean
        style: form
        explode: false
        required: false
      - name: sort
        in: query
        description: comma-separated list of sort expressions; resources will be sorted as specified
        schema:
          type: array
          items:
            type: string
            enum:
            - version
            - -version
            - uploadedDate
            - -uploadedDate
            - preReleaseVersion
            - -preReleaseVersion
        style: form
        explode: false
        required: false
      - name: fields[builds]
        in: query
        description: the fields to include for returned resources of type builds
        schema:
          type: array
          items:
            type: string
            enum:
            - version
            - uploadedDate
            - expirationDate
            - expired
            - minOsVersion
            - lsMinimumSystemVersion
            - computedMinMacOsVersion
            - computedMinVisionOsVersion
            - iconAssetToken
            - processingState
            - buildAudienceType
            - usesNonExemptEncryption
            - preReleaseVersion
            - individualTesters
            - betaGroups
            - betaBuildLocalizations
            - appEncryptionDeclaration
            - betaAppReviewSubmission
            - app
            - buildBetaDetail
            - appStoreVersion
            - icons
            - buildBundles
            - buildUpload
            - perfPowerMetrics
            - diagnosticSignatures
        style: form
        explode: false
        required: false
      - name: fields[preReleaseVersions]
        in: query
        description: the fields to include for returned resources of type preReleaseVersions
        schema:
          type: array
          items:
            type: string
            enum:
            - version
            - platform
            - builds
            - app
        style: form
        explode: false
        required: false
      - name: fields[betaTesters]
        in: query
        description: the fields to include for returned resources of type betaTesters
        schema:
          type: array
          items:
            type: string
            enum:
            - firstName
            - lastName
            - email
            - inviteType
            - state
            - appDevices
            - apps
            - betaGroups
            - builds
        style: form
        explode: false
        required: false
      - name: fields[betaGroups]
        in: query
        description: the fields to include for returned resources of type betaGroups
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - createdDate
            - isInternalGroup
            - hasAccessToAllBuilds
            - publicLinkEnabled
            - publicLinkId
            - publicLinkLimitEnabled
            - publicLinkLimit
            - publicLink
            - feedbackEnabled
            - iosBuildsAvailableForAppleSiliconMac
            - iosBuildsAvailableForAppleVision
            - app
            - builds
            - betaTesters
            - betaRecruitmentCriteria
            - betaRecruitmentCriterionCompatibleBuildCheck
        style: form
        explode: false
        required: false
      - name: fields[betaBuildLocalizations]
        in: query
        description: the fields to include for returned resources of type betaBuildLocalizations
        schema:
          type: array
          items:
            type: string
            enum:
            - whatsNew
            - locale
            - build
        style: form
        explode: false
        required: false
      - name: fields[appEncryptionDeclarations]
        in: query
        description: the fields to include for returned resources of type appEncryptionDeclarations
        schema:
          type: array
          items:
            type: string
            enum:
            - appDescription
            - createdDate
            - usesEncryption
            - exempt
            - containsProprietaryCryptography
            - containsThirdPartyCryptography
            - availableOnFrenchStore
            - platform
            - uploadedDate
            - documentUrl
            - documentName
            - documentType
            - appEncryptionDeclarationState
            - codeValue
            - app
            - builds
            - appEncryptionDeclarationDocument
        style: form
        explode: false
        required: false
      - name: fields[betaAppReviewSubmissions]
        in: query
        description: the fields to include for returned resources of type betaAppReviewSubmissions
        schema:
          type: array
          items:
            type: string
            enum:
            - betaReviewState
            - submittedDate
            - build
        style: form
        explode: false
        required: false
      - name: fields[apps]
        in: query
        description: the fields to include for returned resources of type apps
        schema:
          type: array
          items:
            type: string
            enum:
            - accessibilityUrl
            - name
            - bundleId
            - sku
            - primaryLocale
            - isOrEverWasMadeForKids
            - subscriptionStatusUrl
            - subscriptionStatusUrlVersion
            - subscriptionStatusUrlForSandbox
            - subscriptionStatusUrlVersionForSandbox
            - contentRightsDeclaration
            - streamlinedPurchasingEnabled
            - accessibilityDeclarations
            - appEncryptionDeclarations
            - appStoreIcon
            - ciProduct
            - betaTesters
            - betaGroups
            - appStoreVersions
            - appTags
            - preReleaseVersions
            - betaAppLocalizations
            - builds
            - betaLicenseAgreement
            - betaAppReviewDetail
            - appInfos
            - appClips
            - appPricePoints
            - endUserLicenseAgreement
            - appPriceSchedule
            - appAvailabilityV2
            - inAppPurchases
            - subscriptionGroups
            - gameCenterEnabledVersions
            - perfPowerMetrics
            - appCustomProductPages
            - inAppPurchasesV2
            - promotedPurchases
            - appEvents
            - reviewSubmissions
            - subscriptionGracePeriod
            - customerReviews
            - customerReviewSummarizations
            - gameCenterDetail
            - appStoreVersionExperimentsV2
            - alternativeDistributionKey
            - analyticsReportRequests
            - marketplaceSearchDetail
            - buildUploads
            - backgroundAssets
            - betaFeedbackScreenshotSubmissions
            - betaFeedbackCrashSubmissions
            - searchKeywords
            - webhooks
            - androidToIosAppMappingDetails
        style: form
        explode: false
        required: false
      - name: fields[buildBetaDetails]
        in: query
        description: the fields to include for returned resources of type buildBetaDetails
        schema:
          type: array
          items:
            type: string
            enum:
            - autoNotifyEnabled
            - internalBuildState
            - externalBuildState
            - build
        style: form
        explode: false
        required: false
      - name: fields[appStoreVersions]
        in: query
        description: the fields to include for returned resources of type appStoreVersions
        schema:
          type: array
          items:
            type: string
            enum:
            - platform
            - versionString
            - appStoreState
            - appVersionState
            - copyright
            - reviewType
            - releaseType
            - earliestReleaseDate
            - usesIdfa
            - downloadable
            - createdDate
            - app
            - appStoreVersionLocalizations
            - build
            - appStoreVersionPhasedRelease
            - gameCenterAppVersion
            - routingAppCoverage
            - appStoreReviewDetail
            - appStoreVersionSubmission
            - appClipDefaultExperience
            - appStoreVersionExperiments
            - appStoreVersionExperimentsV2
            - customerReviews
            - alternativeDistributionPackage
        style: form
        explode: false
        required: false
      - name: fields[buildIcons]
        in: query
        description: the fields to include for returned resources of type buildIcons
        schema:
          type: array
          items:
            type: string
            enum:
            - iconAsset
            - iconType
            - masked
            - name
        style: form
        explode: false
        required: false
      - name: fields[buildBundles]
        in: query
        description: the fields to include for returned resources of type buildBundles
        schema:
          type: array
          items:
            type: string
            enum:
            - bundleId
            - bundleType
            - sdkBuild
            - platformBuild
            - fileName
            - hasSirikit
            - hasOnDemandResources
            - hasPrerenderedIcon
            - usesLocationServices
            - isIosBuildMacAppStoreCompatible
            - includesSymbols
            - dSYMUrl
            - supportedArchitectures
            - requiredCapabilities
            - deviceProtocols
            - locales
            - entitlements
            - baDownloadAllowance
            - baMaxInstallSize
            - minimumOsVersion
            - appClipDomainCacheStatus
            - appClipDomainDebugStatus
            - betaAppClipInvocations
            - buildBundleFileSizes
        style: form
        explode: false
        required: false
      - name: fields[buildUploads]
        in: query
        description: the fields to include for returned resources of type buildUploads
        schema:
          type: array
          items:
            type: string
            enum:
            - cfBundleShortVersionString
            - cfBundleVersion
            - createdDate
            - state
            - platform
            - uploadedDate
            - build
            - assetFile
            - assetDescriptionFile
            - assetSpiFile
            - buildUploadFiles
        style: form
        explode: false
        required: false
      - name: limit
        in: query
        description: maximum resources per page
        schema:
          type: integer
          maximum: 200
        style: form
      - name: include
        in: query
        description: comma-separated list of relationships to include
        schema:
          type: array
          items:
            type: string
            enum:
            - preReleaseVersion
            - individualTesters
            - betaGroups
            - betaBuildLocalizations
            - appEncryptionDeclaration
            - betaAppReviewSubmission
            - app
            - buildBetaDetail
            - appStoreVersion
            - icons
            - buildBundles
            - buildUpload
        style: form
        explode: false
        required: false
      - name: limit[betaBuildLocalizations]
        in: query
        description: maximum number of related betaBuildLocalizations returned (when they are included)
        schema:
          type: integer
          maximum: 50
        style: form
        required: false
      - name: limit[betaGroups]
        in: query
        description: maximum number of related betaGroups returned (when they are included)
        schema:
          type: integer
          maximum: 50
        style: form
        required: false
      - name: limit[buildBundles]
        in: query
        description: maximum number of related buildBundles returned (when they are included)
        schema:
          type: integer
          maximum: 50
        style: form
        required: false
      - name: limit[icons]
        in: query
        description: maximum number of related icons returned (when they are included)
        schema:
          type: integer
          maximum: 50
        style: form
        required: false
      - name: limit[individualTesters]
        in: query
        description: maximum number of related individualTesters returned (when they are included)
        schema:
          type: integer
          maximum: 50
        style: form
        required: false
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: List of Builds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildsResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: List Builds
  /v1/builds/{id}:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - Builds
      operationId: builds_getInstance
      parameters:
      - name: fields[builds]
        in: query
        description: the fields to include for returned resources of type builds
        schema:
          type: array
          items:
            type: string
            enum:
            - version
            - uploadedDate
            - expirationDate
            - expired
            - minOsVersion
            - lsMinimumSystemVersion
            - computedMinMacOsVersion
            - computedMinVisionOsVersion
            - iconAssetToken
            - processingState
            - buildAudienceType
            - usesNonExemptEncryption
            - preReleaseVersion
            - individualTesters
            - betaGroups
            - betaBuildLocalizations
            - appEncryptionDeclaration
            - betaAppReviewSubmission
            - app
            - buildBetaDetail
            - appStoreVersion
            - icons
            - buildBundles
            - buildUpload
            - perfPowerMetrics
            - diagnosticSignatures
        style: form
        explode: false
        required: false
      - name: fields[preReleaseVersions]
        in: query
        description: the fields to include for returned resources of type preReleaseVersions
        schema:
          type: array
          items:
            type: string
            enum:
            - version
            - platform
            - builds
            - app
        style: form
        explode: false
        required: false
      - name: fields[betaTesters]
        in: query
        description: the fields to include for returned resources of type betaTesters
        schema:
          type: array
          items:
            type: string
            enum:
            - firstName
            - lastName
            - email
            - inviteType
            - state
            - appDevices
            - apps
            - betaGroups
            - builds
        style: form
        explode: false
        required: false
      - name: fields[betaGroups]
        in: query
        description: the fields to include for returned resources of type betaGroups
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - createdDate
            - isInternalGroup
            - hasAccessToAllBuilds
            - publicLinkEnabled
            - publicLinkId
            - publicLinkLimitEnabled
            - publicLinkLimit
            - publicLink
            - feedbackEnabled
            - iosBuildsAvailableForAppleSiliconMac
            - iosBuildsAvailableForAppleVision
            - app
            - builds
            - betaTesters
            - betaRecruitmentCriteria
            - betaRecruitmentCriterionCompatibleBuildCheck
        style: form
        explode: false
        required: false
      - name: fields[betaBuildLocalizations]
        in: query
        description: the fields to include for returned resources of type betaBuildLocalizations
        schema:
          type: array
          items:
            type: string
            enum:
            - whatsNew
            - locale
            - build
        style: form
        explode: false
        required: false
      - name: fields[appEncryptionDeclarations]
        in: query
        description: the fields to include for returned resources of type appEncryptionDeclarations
        schema:
          type: array
          items:
            type: string
            enum:
            - appDescription
            - createdDate
            - usesEncryption
            - exempt
            - containsProprietaryCryptography
            - containsThirdPartyCryptography
            - availableOnFrenchStore
            - platform
            - uploadedDate
            - documentUrl
            - documentName
            - documentType
            - appEncryptionDeclarationState
            - codeValue
            - app
            - builds
            - appEncryptionDeclarationDocument
        style: form
        explode: false
        required: false
      - name: fields[betaAppReviewSubmissions]
        in: query
        description: the fields to include for returned resources of type betaAppReviewSubmissions
        schema:
          type: array
          items:
            type: string
            enum:
            - betaReviewState
            - submittedDate
            - build
        style: form
        explode: false
        required: false
      - name: fields[apps]
        in: query
        description: the fields to include for returned resources of type apps
        schema:
          type: array
          items:
            type: string
            enum:
            - accessibilityUrl
            - name
            - bundleId
            - sku
            - primaryLocale
            - isOrEverWasMadeForKids
            - subscriptionStatusUrl
            - subscriptionStatusUrlVersion
            - subscriptionStatusUrlForSandbox
            - subscriptionStatusUrlVersionForSandbox
            - contentRightsDeclaration
            - streamlinedPurchasingEnabled
            - accessibilityDeclarations
            - appEncryptionDeclarations
            - appStoreIcon
            - ciProduct
            - betaTesters
            - betaGroups
            - appStoreVersions
            - appTags
            - preReleaseVersions
            - betaAppLocalizations
            - builds
            - betaLicenseAgreement
            - betaAppReviewDetail
            - appInfos
            - appClips
            - appPricePoints
            - endUserLicenseAgreement
            - appPriceSchedule
            - appAvailabilityV2
            - inAppPurchases
            - subscriptionGroups
            - gameCenterEnabledVersions
            - perfPowerMetrics
            - appCustomProductPages
            - inAppPurchasesV2
            - promotedPurchases
            - appEvents
            - reviewSubmissions
            - subscriptionGracePeriod
            - customerReviews
            - customerReviewSummarizations
            - gameCenterDetail
            - appStoreVersionExperimentsV2
            - alternativeDistributionKey
            - analyticsReportRequests
            - marketplaceSearchDetail
            - buildUploads
            - backgroundAssets
            - betaFeedbackScreenshotSubmissions
            - betaFeedbackCrashSubmissions
            - searchKeywords
            - webhooks
            - androidToIosAppMappingDetails
        style: form
        explode: false
        required: false
      - name: fields[buildBetaDetails]
        in: query
        description: the fields to include for returned resources of type buildBetaDetails
        schema:
          type: array
          items:
            type: string
            enum:
            - autoNotifyEnabled
            - internalBuildState
            - externalBuildState
            - build
        style: form
        explode: false
        required: false
      - name: fields[appStoreVersions]
        in: query
        description: the fields to include for returned resources of type appStoreVersions
        schema:
          type: array
          items:
            type: string
            enum:
            - platform
            - versionString
            - appStoreState
            - appVersionState
            - copyright
            - reviewType
            - releaseType
            - earliestReleaseDate
            - usesIdfa
            - downloadable
            - createdDate
            - app
            - appStoreVersionLocalizations
            - build
            - appStoreVersionPhasedRelease
            - gameCenterAppVersion
            - routingAppCoverage
            - appStoreReviewDetail
            - appStoreVersionSubmission
            - appClipDefaultExperience
            - appStoreVersionExperiments
            - appStoreVersionExperimentsV2
            - customerReviews
            - alternativeDistributionPackage
        style: form
        explode: false
        required: false
      - name: fields[buildIcons]
        in: query
        description: the fields to include for returned resources of type buildIcons
        schema:
          type: array
          items:
            type: string
            enum:
            - iconAsset
            - iconType
            - masked
            - name
        style: form
        explode: false
        required: false
      - name: fields[buildBundles]
        in: query
        description: the fields to include for returned resources of type buildBundles
        schema:
          type: array
          items:
            type: string
            enum:
            - bundleId
            - bundleType
            - sdkBuild
            - platformBuild
            - fileName
            - hasSirikit
            - hasOnDemandResources
            - hasPrerenderedIcon
            - usesLocationServices
            - isIosBuildMacAppStoreCompatible
            - includesSymbols
            - dSYMUrl
            - supportedArchitectures
            - requiredCapabilities
            - deviceProtocols
            - locales
            - entitlements
            - baDownloadAllowance
            - baMaxInstallSize
            - minimumOsVersion
            - appClipDomainCacheStatus
            - appClipDomainDebugStatus
            - betaAppClipInvocations
            - buildBundleFileSizes
        style: form
        explode: false
        required: false
      - name: fields[buildUploads]
        in: query
        description: the fields to include for returned resources of type buildUploads
        schema:
          type: array
          items:
            type: string
            enum:
            - cfBundleShortVersionString
            - cfBundleVersion
            - createdDate
            - state
            - platform
            - uploadedDate
            - build
            - assetFile
            - assetDescriptionFile
            - assetSpiFile
            - buildUploadFiles
        style: form
        explode: false
        required: false
      - name: include
        in: query
        description: comma-separated list of relationships to include
        schema:
          type: array
          items:
            type: string
            enum:
            - preReleaseVersion
            - individualTesters
            - betaGroups
            - betaBuildLocalizations
            - appEncryptionDeclaration
            - betaAppReviewSubmission
            - app
            - buildBetaDetail
            - appStoreVersion
            - icons
            - buildBundles
            - buildUpload
        style: form
        explode: false
        required: false
      - name: limit[betaBuildLocalizations]
        in: query
        description: maximum number of related betaBuildLocalizations returned (when they are included)
        schema:
          type: integer
          maximum: 50
        style: form
        required: false
      - name: limit[betaGroups]
        in: query
        description: maximum number of related betaGroups returned (when they are included)
        schema:
          type: integer
          maximum: 50
        style: form
        required: false
      - name: limit[buildBundles]
        in: query
        description: maximum number of related buildBundles returned (when they are included)
        schema:
          type: integer
          maximum: 50
        style: form
        required: false
      - name: limit[icons]
        in: query
        description: maximum number of related icons returned (when they are included)
        schema:
          type: integer
          maximum: 50
        style: form
        required: false
      - name: limit[individualTesters]
        in: query
        description: maximum number of related individualTesters returned (when they are included)
        schema:
          type: integer
          maximum: 50
        style: form
        required: false
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: Single Build
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Get Builds
    patch:
      tags:
      - Builds
      operationId: builds_updateInstance
      requestBody:
        description: Build representation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuildUpdateRequest'
        required: true
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
  

# --- truncated at 32 KB (202 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ios/refs/heads/main/openapi/ios-builds-api-openapi.yml
iOS Builds API

Documentation

Specifications

Other Resources

OpenAPI Specification
