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

The Nominations API from iOS — 2 operation(s) for nominations.

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

Tagged areas include Nominations. 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 5 operations across 2 paths, and defines 21 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/.

5 operations 2 paths 21 schemas 1 DELETE2 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 Nominations 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 5

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

Nominations 5
GET
/v1/nominations
List Nominations
nominations_getCollection 15 params → 400401403200429
POST
/v1/nominations
Create Nominations
nominations_createInstance body → 400401403422201409429
GET
/v1/nominations/{id}
Get Nominations
nominations_getInstance 10 params → 400401403404200429
PATCH
/v1/nominations/{id}
Update Nominations
nominations_updateInstance 1 param body → 400401403404422200409429
DELETE
/v1/nominations/{id}
Delete Nominations
nominations_deleteInstance 1 param → 400401403404204429

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Nomination (5 properties), AppEvent (5 properties), App (5 properties), NominationsResponse (4 properties). Each schema is shown below with its type and property counts.

PagedDocumentLinks
object
3 properties 1 required
ResourceLinks
object
1 property
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
AppEvent
object
5 properties 2 required
csv
string
DocumentLinks
object
1 property 1 required
Actor
object
4 properties 2 required
ErrorResponse
object
1 property
DeviceFamily
string
App
object
5 properties 2 required
RelationshipLinks
object
2 properties
SubscriptionStatusUrlVersion
string
NominationResponse
object
3 properties 2 required
ErrorSourcePointer
object
1 property 1 required
PagingInformation
object
1 property 1 required
Nomination
object
5 properties 2 required
NominationCreateRequest
object
1 property 1 required
NominationUpdateRequest
object
1 property 1 required
NominationsResponse
object
4 properties 2 required
Territory
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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