How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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 User. 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.2.0, 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.2.0
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), PagedDocumentLinks (3 properties). Each schema is shown below with its type and property counts.

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

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
Where this information came from

This is an independent, third-party profile of iOS Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.