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

The AppTags API from iOS — 3 operation(s) for apptags.

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

Tagged areas include AppTags. 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 3 operations across 3 paths, and defines 15 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/.

3 operations 3 paths 15 schemas 2 GET1 PATCH

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 AppTags 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 3

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

AppTags 3
PATCH
/v1/appTags/{id}
Update App Tags
appTags_updateInstance 1 param body → 400401403404422200409429
GET
/v1/appTags/{id}/relationships/territories
List Related App Tags / Territories
appTags_territories_getToManyRelationship 2 params → 400401403404200429
GET
/v1/appTags/{id}/territories
List Related App Tags / Territories
appTags_territories_getToManyRelated 3 params → 400401403404200429

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are AppTag (5 properties), Territory (4 properties), AppTagTerritoriesLinkagesResponse (3 properties), TerritoriesResponse (3 properties). Each schema is shown below with its type and property counts.

DocumentLinks
object
1 property 1 required
RelationshipLinks
object
2 properties
PagedDocumentLinks
object
3 properties 1 required
AppTagUpdateRequest
object
1 property 1 required
AppTagTerritoriesLinkagesResponse
object
3 properties 2 required
ResourceLinks
object
1 property
AppTag
object
5 properties 2 required
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
TerritoriesResponse
object
3 properties 2 required
ErrorResponse
object
1 property
ErrorSourcePointer
object
1 property 1 required
AppTagResponse
object
3 properties 2 required
Territory
object
4 properties 2 required
PagingInformation
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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