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

The UserInvitations API from iOS — 4 operation(s) for userinvitations.

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

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

6 operations 4 paths 18 schemas 1 DELETE4 GET1 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 UserInvitations 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 6

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

UserInvitations 6
GET
/v1/userInvitations
List User Invitations
userInvitations_getCollection 9 params → 400401403200429
POST
/v1/userInvitations
Create User Invitations
userInvitations_createInstance body → 400401403422201409429
GET
/v1/userInvitations/{id}
Get User Invitations
userInvitations_getInstance 5 params → 400401403404200429
DELETE
/v1/userInvitations/{id}
Delete User Invitations
userInvitations_deleteInstance 1 param → 400401403404204429
GET
/v1/userInvitations/{id}/relationships/visibleApps
List Related User Invitations / Visible Apps
userInvitations_visibleApps_getToManyRelationship 2 params → 400401403404200429
GET
/v1/userInvitations/{id}/visibleApps
List Related User Invitations / Visible Apps
userInvitations_visibleApps_getToManyRelated 3 params → 400401403404200429

Schemas 18

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

DocumentLinks
object
1 property 1 required
App
object
5 properties 2 required
PagedDocumentLinks
object
3 properties 1 required
UserRole
string
RelationshipLinks
object
2 properties
SubscriptionStatusUrlVersion
string
ResourceLinks
object
1 property
UserInvitationVisibleAppsLinkagesResponse
object
3 properties 2 required
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
AppsWithoutIncludesResponse
object
3 properties 2 required
UserInvitationResponse
object
3 properties 2 required
UserInvitationsResponse
object
4 properties 2 required
ErrorResponse
object
1 property
UserInvitation
object
5 properties 2 required
ErrorSourcePointer
object
1 property 1 required
UserInvitationCreateRequest
object
1 property 1 required
PagingInformation
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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