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

The Devices API from iOS — 2 operation(s) for devices.

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

Tagged areas include Devices. 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 4 operations across 2 paths, and defines 14 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/.

4 operations 2 paths 14 schemas 2 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 Devices 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 4

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

Devices 4
GET
/v1/devices
List Devices
devices_getCollection 8 params → 400401403200429
POST
/v1/devices
Create Devices
devices_createInstance body → 400401403422201409429
GET
/v1/devices/{id}
Get Devices
devices_getInstance 2 params → 400401403404200429
PATCH
/v1/devices/{id}
Update Devices
devices_updateInstance 1 param body → 400401403404422200409429

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Device (4 properties), PagedDocumentLinks (3 properties), DevicesResponse (3 properties), DeviceResponse (2 properties). Each schema is shown below with its type and property counts.

DocumentLinks
object
1 property 1 required
DeviceCreateRequest
object
1 property 1 required
PagedDocumentLinks
object
3 properties 1 required
DeviceUpdateRequest
object
1 property 1 required
DevicesResponse
object
3 properties 2 required
BundleIdPlatform
string
Device
object
4 properties 2 required
ResourceLinks
object
1 property
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
ErrorResponse
object
1 property
DeviceResponse
object
2 properties 2 required
ErrorSourcePointer
object
1 property 1 required
PagingInformation
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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