Web Service Endpoint

Read User Invitation Information

Get information about a pending invitation to join your team.

URL

GET https://api.appstoreconnect.apple.com/v1/userInvitations/{id}

Path Parameters

id
string
(Required)

An opaque resource ID that uniquely identifies the resource.

Query Parameters

fields[apps]
[string]

Fields to return for included related types.

Possible values: betaAppLocalizations, betaAppReviewDetail, betaGroups, betaLicenseAgreement, betaTesters, builds, bundleId, name, preReleaseVersions, primaryLocale, sku
fields[userInvitations]
[string]

Fields to return for included related types.

Possible values: allAppsVisible, email, expirationDate, firstName, lastName, provisioningAllowed, roles, visibleApps
include
[string]

Relationship data to include in the response.

Value: visibleApps
limit[visibleApps]
integer

Number of included related resources to return.

Maximum: 50

Response Codes

200 OK
UserInvitationResponse
OK
Content-Type: application/json
400 Bad Request
ErrorResponse
Bad Request

An error occurred with your request.

Content-Type: application/json
403 Forbidden
ErrorResponse
Forbidden

Request not authorized.

Content-Type: application/json
404 Not Found
ErrorResponse
Not Found

Resource not found.

Content-Type: application/json

See Also

Getting Invited Users

List Invited Users

Get a list of pending invitations to join your team.