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 Profiles API

The Profiles API from iOS — 8 operation(s) for profiles.

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

Tagged areas include Profiles. 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 10 operations across 8 paths, and defines 24 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/.

10 operations 8 paths 24 schemas 1 DELETE8 GET1 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 Profiles 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 10

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

Profiles 10
GET
/v1/profiles
List Profiles
profiles_getCollection 13 params → 400401403200429
POST
/v1/profiles
Create Profiles
profiles_createInstance body → 400401403422201409429
GET
/v1/profiles/{id}
Get Profiles
profiles_getInstance 8 params → 400401403404200429
DELETE
/v1/profiles/{id}
Delete Profiles
profiles_deleteInstance 1 param → 400401403404204429
GET
/v1/profiles/{id}/relationships/bundleId
Get Related Profiles / Bundle ID
profiles_bundleId_getToOneRelationship 1 param → 400401403404200429
GET
/v1/profiles/{id}/bundleId
Get Related Profiles / Bundle ID
profiles_bundleId_getToOneRelated 2 params → 400401403404200429
GET
/v1/profiles/{id}/relationships/certificates
List Related Profiles / Certificates
profiles_certificates_getToManyRelationship 2 params → 400401403404200429
GET
/v1/profiles/{id}/certificates
List Related Profiles / Certificates
profiles_certificates_getToManyRelated 3 params → 400401403404200429
GET
/v1/profiles/{id}/relationships/devices
List Related Profiles / Devices
profiles_devices_getToManyRelationship 2 params → 400401403404200429
GET
/v1/profiles/{id}/devices
List Related Profiles / Devices
profiles_devices_getToManyRelated 3 params → 400401403404200429

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are Certificate (5 properties), Profile (5 properties), BundleId (5 properties), Device (4 properties). Each schema is shown below with its type and property counts.

ProfilesResponse
object
4 properties 2 required
PagedDocumentLinks
object
3 properties 1 required
ResourceLinks
object
1 property
Device
object
4 properties 2 required
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
Profile
object
5 properties 2 required
DocumentLinks
object
1 property 1 required
ErrorResponse
object
1 property
ProfileResponse
object
3 properties 2 required
Certificate
object
5 properties 2 required
CertificatesWithoutIncludesResponse
object
3 properties 2 required
ProfileCreateRequest
object
1 property 1 required
RelationshipLinks
object
2 properties
BundleId
object
5 properties 2 required
ErrorSourcePointer
object
1 property 1 required
CertificateType
string
PagingInformation
object
1 property 1 required
BundleIdPlatform
string
ProfileDevicesLinkagesResponse
object
3 properties 2 required
DevicesWithoutIncludesResponse
object
3 properties 2 required
ProfileBundleIdLinkageResponse
object
2 properties 2 required
ProfileCertificatesLinkagesResponse
object
3 properties 2 required
BundleIdWithoutIncludesResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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