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

The BetaTesters API from iOS — 9 operation(s) for betatesters.

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

Tagged areas include BetaTesters. 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 16 operations across 9 paths, and defines 31 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/.

16 operations 9 paths 31 schemas 4 DELETE9 GET3 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 BetaTesters 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 16

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

BetaTesters 16
GET
/v1/betaTesters
List Beta Testers
betaTesters_getCollection 18 params → 400401403200429
POST
/v1/betaTesters
Create Beta Testers
betaTesters_createInstance body → 400401403422201409429
GET
/v1/betaTesters/{id}
Get Beta Testers
betaTesters_getInstance 9 params → 400401403404200429
DELETE
/v1/betaTesters/{id}
Delete Beta Testers
betaTesters_deleteInstance 1 param → 400401403404202204429
GET
/v1/betaTesters/{id}/relationships/apps
List Related Beta Testers / Apps
betaTesters_apps_getToManyRelationship 2 params → 400401403404200429
DELETE
/v1/betaTesters/{id}/relationships/apps
Remove Related Beta Testers / Apps
betaTesters_apps_deleteToManyRelationship 1 param body → 400401403404422409202204
GET
/v1/betaTesters/{id}/apps
List Related Beta Testers / Apps
betaTesters_apps_getToManyRelated 3 params → 400401403404200429
GET
/v1/betaTesters/{id}/relationships/betaGroups
List Related Beta Testers / Beta Groups
betaTesters_betaGroups_getToManyRelationship 2 params → 400401403404200429
POST
/v1/betaTesters/{id}/relationships/betaGroups
Add Related Beta Testers / Beta Groups
betaTesters_betaGroups_createToManyRelationship 1 param body → 400401403404422409204429
DELETE
/v1/betaTesters/{id}/relationships/betaGroups
Remove Related Beta Testers / Beta Groups
betaTesters_betaGroups_deleteToManyRelationship 1 param body → 400401403404422409204429
GET
/v1/betaTesters/{id}/betaGroups
List Related Beta Testers / Beta Groups
betaTesters_betaGroups_getToManyRelated 3 params → 400401403404200429
GET
/v1/betaTesters/{id}/relationships/builds
List Related Beta Testers / Builds
betaTesters_builds_getToManyRelationship 2 params → 400401403404200429
POST
/v1/betaTesters/{id}/relationships/builds
Add Related Beta Testers / Builds
betaTesters_builds_createToManyRelationship 1 param body → 400401403404422409204429
DELETE
/v1/betaTesters/{id}/relationships/builds
Remove Related Beta Testers / Builds
betaTesters_builds_deleteToManyRelationship 1 param body → 400401403404422409204429
GET
/v1/betaTesters/{id}/builds
List Related Beta Testers / Builds
betaTesters_builds_getToManyRelated 3 params → 400401403404200429
GET
/v1/betaTesters/{id}/metrics/betaTesterUsages
Get Metrics Beta Testers / Beta Tester Usages
betaTesters_betaTesterUsages_getMetrics 4 params → 400401403404200429

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are BetaTester (5 properties), Build (5 properties), BetaGroup (5 properties), App (5 properties). Each schema is shown below with its type and property counts.

BetaTesterBetaGroupsLinkagesRequest
object
1 property 1 required
ImageAsset
object
3 properties
PagedDocumentLinks
object
3 properties 1 required
ResourceLinks
object
1 property
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
BuildsWithoutIncludesResponse
object
3 properties 2 required
BetaTester
object
5 properties 2 required
BetaGroupsWithoutIncludesResponse
object
3 properties 2 required
DocumentLinks
object
1 property 1 required
BetaTesterBuildsLinkagesRequest
object
1 property 1 required
ErrorResponse
object
1 property
BetaTesterState
string
App
object
5 properties 2 required
Build
object
5 properties 2 required
RelationshipLinks
object
2 properties
SubscriptionStatusUrlVersion
string
BetaTesterCreateRequest
object
1 property 1 required
AppsWithoutIncludesResponse
object
3 properties 2 required
BetaInviteType
string
ErrorSourcePointer
object
1 property 1 required
BetaTestersResponse
object
4 properties 2 required
PagingInformation
object
1 property 1 required
BetaTesterBuildsLinkagesResponse
object
3 properties 2 required
BuildAudienceType
string
BetaTesterAppsLinkagesResponse
object
3 properties 2 required
BetaGroup
object
5 properties 2 required
BetaTesterUsagesV1MetricResponse
object
3 properties 2 required
BetaTesterAppsLinkagesRequest
object
1 property 1 required
BetaTesterResponse
object
3 properties 2 required
BetaTesterBetaGroupsLinkagesResponse
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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