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

The PassTypeIds API from iOS — 4 operation(s) for passtypeids.

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

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

7 operations 4 paths 19 schemas 1 DELETE4 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 PassTypeIds 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 7

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

PassTypeIds 7
GET
/v1/passTypeIds
List Pass Type Ids
passTypeIds_getCollection 9 params → 400401403200429
POST
/v1/passTypeIds
Create Pass Type Ids
passTypeIds_createInstance body → 400401403422201409429
GET
/v1/passTypeIds/{id}
Get Pass Type Ids
passTypeIds_getInstance 5 params → 400401403404200429
PATCH
/v1/passTypeIds/{id}
Update Pass Type Ids
passTypeIds_updateInstance 1 param body → 400401403404422200409429
DELETE
/v1/passTypeIds/{id}
Delete Pass Type Ids
passTypeIds_deleteInstance 1 param → 400401403404204429
GET
/v1/passTypeIds/{id}/relationships/certificates
List Related Pass Type Ids / Certificates
passTypeIds_certificates_getToManyRelationship 2 params → 400401403404200429
GET
/v1/passTypeIds/{id}/certificates
List Related Pass Type Ids / Certificates
passTypeIds_certificates_getToManyRelated 10 params → 400401403404200429

Schemas 19

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

PassTypeIdCertificatesLinkagesResponse
object
3 properties 2 required
PagedDocumentLinks
object
3 properties 1 required
PassTypeIdsResponse
object
4 properties 2 required
ResourceLinks
object
1 property
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
PassTypeId
object
5 properties 2 required
DocumentLinks
object
1 property 1 required
PassTypeIdResponse
object
3 properties 2 required
PassTypeIdCreateRequest
object
1 property 1 required
ErrorResponse
object
1 property
Certificate
object
5 properties 2 required
RelationshipLinks
object
2 properties
ErrorSourcePointer
object
1 property 1 required
CertificateType
string
PagingInformation
object
1 property 1 required
BundleIdPlatform
string
PassTypeIdUpdateRequest
object
1 property 1 required
CertificatesResponse
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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