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

The Users API from iOS — 4 operation(s) for users.

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

Tagged areas include Users. 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 9 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/.

9 operations 4 paths 19 schemas 2 DELETE4 GET2 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 Users 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 9

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

Users 9
GET
/v1/users
List Users
users_getCollection 9 params → 400401403200429
GET
/v1/users/{id}
Get Users
users_getInstance 5 params → 400401403404200429
PATCH
/v1/users/{id}
Update Users
users_updateInstance 1 param body → 400401403404422200409429
DELETE
/v1/users/{id}
Delete Users
users_deleteInstance 1 param → 400401403404204429
GET
/v1/users/{id}/relationships/visibleApps
List Related Users / Visible Apps
users_visibleApps_getToManyRelationship 2 params → 400401403404200429
POST
/v1/users/{id}/relationships/visibleApps
Add Related Users / Visible Apps
users_visibleApps_createToManyRelationship 1 param body → 400401403404422409204429
PATCH
/v1/users/{id}/relationships/visibleApps
Replace Related Users / Visible Apps
users_visibleApps_replaceToManyRelationship 1 param body → 400401403404422409204429
DELETE
/v1/users/{id}/relationships/visibleApps
Remove Related Users / Visible Apps
users_visibleApps_deleteToManyRelationship 1 param body → 400401403404422409204429
GET
/v1/users/{id}/visibleApps
List Related Users / Visible Apps
users_visibleApps_getToManyRelated 3 params → 400401403404200429

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are App (5 properties), User (5 properties), UsersResponse (4 properties), UserResponse (3 properties). Each schema is shown below with its type and property counts.

PagedDocumentLinks
object
3 properties 1 required
UserVisibleAppsLinkagesRequest
object
1 property 1 required
ResourceLinks
object
1 property
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
User
object
5 properties 2 required
UserVisibleAppsLinkagesResponse
object
3 properties 2 required
UsersResponse
object
4 properties 2 required
DocumentLinks
object
1 property 1 required
UserUpdateRequest
object
1 property 1 required
ErrorResponse
object
1 property
App
object
5 properties 2 required
RelationshipLinks
object
2 properties
SubscriptionStatusUrlVersion
string
AppsWithoutIncludesResponse
object
3 properties 2 required
UserResponse
object
3 properties 2 required
ErrorSourcePointer
object
1 property 1 required
PagingInformation
object
1 property 1 required
UserRole
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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