iOS BundleIds API is one of 199 APIs that iOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include BundleIds. 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
11 operations
across 8 paths,
and defines 28 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/.
11 operations8 paths28 schemas1 DELETE8 GET1 PATCH1 POST
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 BundleIds 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 11
Across 8 paths, the API surfaces 11 operations — 1 DELETE, 8 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are CapabilitySetting (8 properties), CapabilityOption (6 properties), BundleId (5 properties), App (5 properties). Each schema is shown below with its type and property counts.
PagedDocumentLinks
object
3 properties1 required
ResourceLinks
object
1 property
ErrorSourceParameter
object
1 property1 required
ErrorLinks
object
2 properties
Profile
object
5 properties2 required
BundleIdCapability
object
4 properties2 required
CapabilityOption
object
6 properties
DocumentLinks
object
1 property1 required
BundleIdsResponse
object
4 properties2 required
ErrorResponse
object
1 property
BundleIdBundleIdCapabilitiesLinkagesResponse
object
3 properties2 required
BundleIdAppLinkageResponse
object
2 properties2 required
CapabilitySetting
object
8 properties
BundleIdCapabilitiesWithoutIncludesResponse
object
3 properties2 required
BundleIdUpdateRequest
object
1 property1 required
BundleIdResponse
object
3 properties2 required
CapabilityType
string
App
object
5 properties2 required
RelationshipLinks
object
2 properties
SubscriptionStatusUrlVersion
string
BundleId
object
5 properties2 required
BundleIdProfilesLinkagesResponse
object
3 properties2 required
ErrorSourcePointer
object
1 property1 required
BundleIdCreateRequest
object
1 property1 required
PagingInformation
object
1 property1 required
BundleIdPlatform
string
ProfilesWithoutIncludesResponse
object
3 properties2 required
AppWithoutIncludesResponse
object
2 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
