Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

iOS CiProducts API

The CiProducts API from iOS — 12 operation(s) for ciproducts.

iOS CiProducts API is one of 199 APIs that iOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CiProducts. 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 13 operations across 12 paths, and defines 88 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/.

13 operations 12 paths 88 schemas 1 DELETE12 GET

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

iOS CiProducts 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 13

Across 12 paths, the API surfaces 13 operations — 1 DELETE, 12 GET. Each is listed below with its method, path, parameters, and response codes.

CiProducts 13
GET
/v1/ciProducts
List Ci Products
ciProducts_getCollection 9 params → 400401403200429
GET
/v1/ciProducts/{id}
Get Ci Products
ciProducts_getInstance 7 params → 400401403404200429
DELETE
/v1/ciProducts/{id}
Delete Ci Products
ciProducts_deleteInstance 1 param → 400401403404204429
GET
/v1/ciProducts/{id}/relationships/additionalRepositories
List Related Ci Products / Additional Repositories
ciProducts_additionalRepositories_getToManyRelationship 2 params → 400401403404200429
GET
/v1/ciProducts/{id}/additionalRepositories
List Related Ci Products / Additional Repositories
ciProducts_additionalRepositories_getToManyRelated 7 params → 400401403404200429
GET
/v1/ciProducts/{id}/relationships/app
Get Related Ci Products / App
ciProducts_app_getToOneRelationship 1 param → 400401403404200429
GET
/v1/ciProducts/{id}/app
Get Related Ci Products / App
ciProducts_app_getToOneRelated 45 params → 400401403404200429
GET
/v1/ciProducts/{id}/relationships/buildRuns
List Related Ci Products / Build Runs
ciProducts_buildRuns_getToManyRelationship 2 params → 400401403404200429
GET
/v1/ciProducts/{id}/buildRuns
List Related Ci Products / Build Runs
ciProducts_buildRuns_getToManyRelated 12 params → 400401403404200429
GET
/v1/ciProducts/{id}/relationships/primaryRepositories
List Related Ci Products / Primary Repositories
ciProducts_primaryRepositories_getToManyRelationship 2 params → 400401403404200429
GET
/v1/ciProducts/{id}/primaryRepositories
List Related Ci Products / Primary Repositories
ciProducts_primaryRepositories_getToManyRelated 7 params → 400401403404200429
GET
/v1/ciProducts/{id}/relationships/workflows
List Related Ci Products / Workflows
ciProducts_workflows_getToManyRelationship 2 params → 400401403404200429
GET
/v1/ciProducts/{id}/workflows
List Related Ci Products / Workflows
ciProducts_workflows_getToManyRelated 8 params → 400401403404200429

Schemas 88

The contract defines 88 schemas that model the data the API accepts and returns. The most detailed are CiAction (8 properties), ScmRepository (5 properties), EndUserLicenseAgreement (5 properties), Build (5 properties). Each schema is shown below with its type and property counts.

BrazilAgeRating
string
AppClip
object
5 properties 2 required
ErrorSourceParameter
object
1 property 1 required
CiProductsResponse
object
4 properties 2 required
CiXcodeVersion
object
5 properties 2 required
AppVersionState
string
CiWorkflowsResponse
object
4 properties 2 required
DocumentLinks
object
1 property 1 required
BuildIcon
object
4 properties 2 required
CiManualPullRequestStartCondition
object
2 properties
PromotedPurchase
object
5 properties 2 required
BundleId
object
5 properties 2 required
AppCustomProductPage
object
5 properties 2 required
BundleIdPlatform
string
CiPullRequestStartCondition
object
4 properties
CiTagPatterns
object
2 properties
ScmRepositoriesResponse
object
4 properties 2 required
AppStoreAgeRating
string
CiProductAdditionalRepositoriesLinkagesResponse
object
3 properties 2 required
CiBranchStartCondition
object
3 properties
ImageAsset
object
3 properties
PagedDocumentLinks
object
3 properties 1 required
CiExecutionProgress
string
BetaLicenseAgreement
object
5 properties 2 required
SubscriptionGroup
object
5 properties 2 required
CiTestDestinationKind
string
AppEncryptionDeclarationState
string
ErrorResponse
object
1 property
AndroidToIosAppMappingDetail
object
4 properties 2 required
CiBuildRunsResponse
object
4 properties 2 required
CiProductBuildRunsLinkagesResponse
object
3 properties 2 required
ErrorSourcePointer
object
1 property 1 required
PagingInformation
object
1 property 1 required
CiStartConditionFileMatcher
object
3 properties
CiCompletionStatus
string
BetaAppLocalization
object
5 properties 2 required
CiProductPrimaryRepositoriesLinkagesResponse
object
3 properties 2 required
GameCenterDetail
object
5 properties 2 required
CiGitRefKind
string
CiTagStartCondition
object
3 properties
ErrorLinks
object
2 properties
AppInfo
object
5 properties 2 required
ScmPullRequest
object
5 properties 2 required
CiAction
object
8 properties
Platform
string
CiProduct
object
5 properties 2 required
InAppPurchase
object
5 properties 2 required
CiProductAppLinkageResponse
object
2 properties 2 required
CiTestDestination
object
5 properties
CiMacOsVersion
object
5 properties 2 required
App
object
5 properties 2 required
ScmProvider
object
5 properties 2 required
RelationshipLinks
object
2 properties
AppStoreVersionExperimentV2
object
5 properties 2 required
CiManualBranchStartCondition
object
1 property
BetaAppReviewDetail
object
5 properties 2 required
BuildAudienceType
string
ReviewSubmission
object
5 properties 2 required
SubscriptionGracePeriod
object
4 properties 2 required
BetaGroup
object
5 properties 2 required
CiScheduledStartCondition
object
2 properties
CiWorkflow
object
5 properties 2 required
ScmGitReference
object
5 properties 2 required
CiFilesAndFoldersRule
object
2 properties
CiProductResponse
object
3 properties 2 required
CiManualTagStartCondition
object
1 property
CiProductWorkflowsLinkagesResponse
object
3 properties 2 required
CiActionType
string
ResourceLinks
object
1 property
GameCenterEnabledVersion
object
5 properties 2 required
AppEvent
object
5 properties 2 required
AppResponse
object
3 properties 2 required
CiIssueCounts
object
4 properties
PrereleaseVersion
object
5 properties 2 required
KidsAgeBand
string
AppEncryptionDeclaration
object
5 properties 2 required
Build
object
5 properties 2 required
SubscriptionStatusUrlVersion
string
EndUserLicenseAgreement
object
5 properties 2 required
ScmRepository
object
5 properties 2 required
AppStoreVersion
object
5 properties 2 required
CiGitUser
object
2 properties
ScmProviderType
object
3 properties
SubscriptionGracePeriodDuration
string
IconAssetType
string
CiBranchPatterns
object
2 properties
CiBuildRun
object
5 properties 2 required
AppStoreVersionState
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ios-ciproducts-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