App Store Connect

App · 20 actions

Read apps, TestFlight builds, testers, reviews, versions, signing resources and account users.

Actions

ActionWhat it does
Get appGet app.
Get beta groupGet beta group.
Get beta testerGet beta tester.
Get buildGet build.
Get bundle IDGet bundle ID.
Get reviewGet review.
Get userGet user.
List app beta feedbackList app beta feedback.
List app infosList app infos.
List app reviewsList app reviews.
List app versionsList app versions.
List appsList apps.
List beta groupsList beta groups.
List beta testersList beta testers.
List buildsList builds.
List bundle IDsList bundle IDs.
List certificatesList certificates.
List devicesList devices.
List profilesList profiles.
List usersList users.

Get app

Get app.

Inputs

IdidtextRequired
the id of the requested resource

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "accessibilityUrl": "example",
        "bundleId": "example",
        "contentRightsDeclaration": "DOES_NOT_USE_THIRD_PARTY_CONTENT",
        "isOrEverWasMadeForKids": false,
        "name": "example",
        "primaryLocale": "example",
        "sku": "example",
        "streamlinedPurchasingEnabled": false,
        "subscriptionStatusUrl": "example",
        "subscriptionStatusUrlForSandbox": "example",
        "subscriptionStatusUrlVersion": "V1",
        "subscriptionStatusUrlVersionForSandbox": "V1"
      },
      "id": "example",
      "links": {
        "self": "example"
      },
      "relationships": {
        "accessibilityDeclarations": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "alternativeDistributionKey": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "analyticsReportRequests": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "androidToIosAppMappingDetails": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "appAvailabilityV2": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "appClips": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "appCustomProductPages": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "appEncryptionDeclarations": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "appEvents": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "appInfos": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "appPricePoints": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "appPriceSchedule": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "appStoreIcon": {
          "data": {
            "id": "example",
            "type": "buildIcons"
          }
        },
        "appStoreVersionExperimentsV2": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "appStoreVersions": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "appTags": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "assetLibrary": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "backgroundAssets": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "betaAppLocalizations": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "betaAppReviewDetail": {
          "data": {
            "id": "example",
            "type": "betaAppReviewDetails"
          },
          "links": {
            "related": {},
            "self": {}
          }
        },
        "betaFeedbackCrashSubmissions": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "betaFeedbackScreenshotSubmissions": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "betaGroups": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "betaLicenseAgreement": {
          "data": {
            "id": "example",
            "type": "betaLicenseAgreements"
          },
          "links": {
            "related": {},
            "self": {}
          }
        },
        "betaTesters": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "buildUploads": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "builds": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "ciProduct": {
          "data": {
            "id": "example",
            "type": "ciProducts"
          },
          "links": {
            "related": {},
            "self": {}
          }
        },
        "customerReviewSummarizations": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "customerReviews": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "endUserLicenseAgreement": {
          "data": {
            "id": "example",
            "type": "endUserLicenseAgreements"
          },
          "links": {
            "related": {},
            "self": {}
          }
        },
        "gameCenterDetail": {
          "data": {
            "id": "example",
            "type": "gameCenterDetails"
          },
          "links": {
            "related": {},
            "self": {}
          }
        },
        "gameCenterEnabledVersions": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "inAppPurchases": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "inAppPurchasesV2": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "marketplaceSearchDetail": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "perfPowerMetrics": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "performanceOverviews": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "preReleaseVersions": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "promotedPurchases": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "retentionMessages": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "reviewSubmissions": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "searchKeywords": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "subscriptionGracePeriod": {
          "data": {
            "id": "example",
            "type": "subscriptionGracePeriods"
          },
          "links": {
            "related": {},
            "self": {}
          }
        },
        "subscriptionGroups": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "webhooks": {
          "links": {
            "related": {},
            "self": {}
          }
        }
      },
      "type": "apps"
    },
    "included": [],
    "links": {
      "self": "example"
    }
  }
}

Get beta group

Get beta group.

Inputs

IdidtextRequired
the id of the requested resource

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "createdDate": "example",
        "feedbackEnabled": false,
        "hasAccessToAllBuilds": false,
        "iosBuildsAvailableForAppleSiliconMac": false,
        "iosBuildsAvailableForAppleVision": false,
        "isInternalGroup": false,
        "name": "example",
        "publicLink": "example",
        "publicLinkEnabled": false,
        "publicLinkId": "example",
        "publicLinkLimit": 1,
        "publicLinkLimitEnabled": false
      },
      "id": "example",
      "links": {
        "self": "example"
      },
      "relationships": {
        "app": {
          "data": {
            "id": "example",
            "type": "apps"
          },
          "links": {
            "related": {},
            "self": {}
          }
        },
        "betaRecruitmentCriteria": {
          "data": {
            "id": "example",
            "type": "betaRecruitmentCriteria"
          },
          "links": {
            "related": {},
            "self": {}
          }
        },
        "betaRecruitmentCriterionCompatibleBuildCheck": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "betaTesters": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "builds": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        }
      },
      "type": "betaGroups"
    },
    "included": [],
    "links": {
      "self": "example"
    }
  }
}

Get beta tester

Get beta tester.

Inputs

IdidtextRequired
the id of the requested resource

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "appDevices": [],
        "email": "example",
        "firstName": "example",
        "inviteType": "EMAIL",
        "lastName": "example",
        "state": "NOT_INVITED"
      },
      "id": "example",
      "links": {
        "self": "example"
      },
      "relationships": {
        "apps": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "betaGroups": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "builds": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        }
      },
      "type": "betaTesters"
    },
    "included": [],
    "links": {
      "self": "example"
    }
  }
}

Get build

Get build.

Inputs

IdidtextRequired
the id of the requested resource

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "buildAudienceType": "INTERNAL_ONLY",
        "computedMinMacOsVersion": "example",
        "computedMinVisionOsVersion": "example",
        "expirationDate": "example",
        "expired": false,
        "iconAssetToken": {
          "height": 1,
          "templateUrl": "example",
          "width": 1
        },
        "lsMinimumSystemVersion": "example",
        "minOsVersion": "example",
        "processingState": "PROCESSING",
        "uploadedDate": "example",
        "usesNonExemptEncryption": false,
        "version": "example"
      },
      "id": "example",
      "links": {
        "self": "example"
      },
      "relationships": {
        "app": {
          "data": {
            "id": "example",
            "type": "apps"
          },
          "links": {
            "related": {},
            "self": {}
          }
        },
        "appEncryptionDeclaration": {
          "data": {
            "id": "example",
            "type": "appEncryptionDeclarations"
          },
          "links": {
            "related": {},
            "self": {}
          }
        },
        "appStoreVersion": {
          "data": {
            "id": "example",
            "type": "appStoreVersions"
          },
          "links": {
            "related": {},
            "self": {}
          }
        },
        "betaAppReviewSubmission": {
          "data": {
            "id": "example",
            "type": "betaAppReviewSubmissions"
          },
          "links": {
            "related": {},
            "self": {}
          }
        },
        "betaBuildLocalizations": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "betaGroups": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "buildBetaDetail": {
          "data": {
            "id": "example",
            "type": "buildBetaDetails"
          },
          "links": {
            "related": {},
            "self": {}
          }
        },
        "buildBundles": {
          "data": [],
          "meta": {
            "paging": {}
          }
        },
        "buildUpload": {
          "data": {
            "id": "example",
            "type": "buildUploads"
          }
        },
        "diagnosticSignatures": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "icons": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "individualTesters": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "perfPowerMetrics": {
          "links": {
            "related": {},
            "self": {}
          }
        },
        "preReleaseVersion": {
          "data": {
            "id": "example",
            "type": "preReleaseVersions"
          },
          "links": {
            "related": {},
            "self": {}
          }
        }
      },
      "type": "builds"
    },
    "included": [],
    "links": {
      "self": "example"
    }
  }
}

Get bundle ID

Get bundle ID.

Inputs

IdidtextRequired
the id of the requested resource

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "identifier": "example",
        "name": "example",
        "platform": "IOS",
        "seedId": "example"
      },
      "id": "example",
      "links": {
        "self": "example"
      },
      "relationships": {
        "app": {
          "data": {
            "id": "example",
            "type": "apps"
          },
          "links": {
            "related": {},
            "self": {}
          }
        },
        "bundleIdCapabilities": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        },
        "profiles": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        }
      },
      "type": "bundleIds"
    },
    "included": [],
    "links": {
      "self": "example"
    }
  }
}

Get review

Get review.

Inputs

IdidtextRequired
the id of the requested resource

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "body": "example",
        "createdDate": "example",
        "rating": 1,
        "reviewerNickname": "example",
        "territory": "ABW",
        "title": "example"
      },
      "id": "example",
      "links": {
        "self": "example"
      },
      "relationships": {
        "response": {
          "data": {
            "id": "example",
            "type": "customerReviewResponses"
          },
          "links": {
            "related": {},
            "self": {}
          }
        },
        "reviewTerritory": {
          "data": {
            "id": "example",
            "type": "territories"
          }
        }
      },
      "type": "customerReviews"
    },
    "included": [],
    "links": {
      "self": "example"
    }
  }
}

Get user

Get user.

Inputs

IdidtextRequired
the id of the requested resource

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "allAppsVisible": false,
        "firstName": "example",
        "lastName": "example",
        "provisioningAllowed": false,
        "roles": [],
        "username": "example"
      },
      "id": "example",
      "links": {
        "self": "example"
      },
      "relationships": {
        "visibleApps": {
          "data": [],
          "links": {
            "related": {},
            "self": {}
          },
          "meta": {
            "paging": {}
          }
        }
      },
      "type": "users"
    },
    "included": [],
    "links": {
      "self": "example"
    }
  }
}

List app beta feedback

List app beta feedback.

Inputs

IdidtextRequired
the id of the requested resource
Sortsortlist
comma-separated list of sort expressions; resources will be sorted as specifiedOne or more of: createdDate, -createdDate.
Limitlimitnumber
maximum resources per pageAt most 200.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "links": {
      "first": "example",
      "next": "example",
      "self": "example"
    },
    "meta": {
      "paging": {
        "limit": 1,
        "nextCursor": "example",
        "total": 1
      }
    }
  }
}

List app infos

List app infos.

Inputs

IdidtextRequired
the id of the requested resource
Limitlimitnumber
maximum resources per pageAt most 200.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "links": {
      "first": "example",
      "next": "example",
      "self": "example"
    },
    "meta": {
      "paging": {
        "limit": 1,
        "nextCursor": "example",
        "total": 1
      }
    }
  }
}

List app reviews

List app reviews.

Inputs

IdidtextRequired
the id of the requested resource
Sortsortlist
comma-separated list of sort expressions; resources will be sorted as specifiedOne or more of: rating, -rating, createdDate, -createdDate.
Limitlimitnumber
maximum resources per pageAt most 200.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "links": {
      "first": "example",
      "next": "example",
      "self": "example"
    },
    "meta": {
      "paging": {
        "limit": 1,
        "nextCursor": "example",
        "total": 1
      }
    }
  }
}

List app versions

List app versions.

Inputs

IdidtextRequired
the id of the requested resource
Platformfilter_platformlist
filter by attribute 'platform'One or more of: IOS, MAC_OS (Mac os), TV_OS (Tv os), VISION_OS (Vision os).
Limitlimitnumber
maximum resources per pageAt most 200.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "links": {
      "first": "example",
      "next": "example",
      "self": "example"
    },
    "meta": {
      "paging": {
        "limit": 1,
        "nextCursor": "example",
        "total": 1
      }
    }
  }
}

List apps

List apps.

Inputs

Bundle idfilter_bundle_idlist
filter by attribute 'bundleId'
Sortsortlist
comma-separated list of sort expressions; resources will be sorted as specifiedOne or more of: name, -name, bundleId, -bundleId, sku, -sku.
Limitlimitnumber
maximum resources per pageAt most 200.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "links": {
      "first": "example",
      "next": "example",
      "self": "example"
    },
    "meta": {
      "paging": {
        "limit": 1,
        "nextCursor": "example",
        "total": 1
      }
    }
  }
}

List beta groups

List beta groups.

Inputs

Appfilter_applist
filter by id(s) of related 'app'
Sortsortlist
comma-separated list of sort expressions; resources will be sorted as specifiedOne or more of: name, -name, createdDate, -createdDate, publicLinkEnabled, -publicLinkEnabled, publicLinkLimit, -publicLinkLimit.
Limitlimitnumber
maximum resources per pageAt most 200.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "links": {
      "first": "example",
      "next": "example",
      "self": "example"
    },
    "meta": {
      "paging": {
        "limit": 1,
        "nextCursor": "example",
        "total": 1
      }
    }
  }
}

List beta testers

List beta testers.

Inputs

Emailfilter_emaillist
filter by attribute 'email'
Sortsortlist
comma-separated list of sort expressions; resources will be sorted as specifiedOne or more of: firstName, -firstName, lastName, -lastName, email, -email, inviteType, -inviteType, state, -state.
Limitlimitnumber
maximum resources per pageAt most 200.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "links": {
      "first": "example",
      "next": "example",
      "self": "example"
    },
    "meta": {
      "paging": {
        "limit": 1,
        "nextCursor": "example",
        "total": 1
      }
    }
  }
}

List builds

List builds.

Inputs

Expiredfilter_expiredlist
filter by attribute 'expired'
Processing statefilter_processing_statelist
filter by attribute 'processingState'One or more of: PROCESSING, FAILED, INVALID, VALID.
Appfilter_applist
filter by id(s) of related 'app'
Sortsortlist
comma-separated list of sort expressions; resources will be sorted as specifiedOne or more of: version, -version, uploadedDate, -uploadedDate, preReleaseVersion, -preReleaseVersion.
Limitlimitnumber
maximum resources per pageAt most 200.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "links": {
      "first": "example",
      "next": "example",
      "self": "example"
    },
    "meta": {
      "paging": {
        "limit": 1,
        "nextCursor": "example",
        "total": 1
      }
    }
  }
}

List bundle IDs

List bundle IDs.

Inputs

Platformfilter_platformlist
filter by attribute 'platform'One or more of: IOS, MAC_OS (Mac os), UNIVERSAL.
Sortsortlist
comma-separated list of sort expressions; resources will be sorted as specifiedOne or more of: name, -name, platform, -platform, identifier, -identifier, seedId, -seedId, id, -id.
Limitlimitnumber
maximum resources per pageAt most 200.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "links": {
      "first": "example",
      "next": "example",
      "self": "example"
    },
    "meta": {
      "paging": {
        "limit": 1,
        "nextCursor": "example",
        "total": 1
      }
    }
  }
}

List certificates

List certificates.

Inputs

Sortsortlist
comma-separated list of sort expressions; resources will be sorted as specifiedOne or more of: displayName, -displayName, certificateType, -certificateType, serialNumber, -serialNumber, id, -id.
Limitlimitnumber
maximum resources per pageAt most 200.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "links": {
      "first": "example",
      "next": "example",
      "self": "example"
    },
    "meta": {
      "paging": {
        "limit": 1,
        "nextCursor": "example",
        "total": 1
      }
    }
  }
}

List devices

List devices.

Inputs

Platformfilter_platformlist
filter by attribute 'platform'One or more of: IOS, MAC_OS (Mac os), UNIVERSAL.
Sortsortlist
comma-separated list of sort expressions; resources will be sorted as specifiedOne or more of: name, -name, platform, -platform, udid, -udid, status, -status, id, -id.
Limitlimitnumber
maximum resources per pageAt most 200.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": [],
    "links": {
      "first": "example",
      "next": "example",
      "self": "example"
    },
    "meta": {
      "paging": {
        "limit": 1,
        "nextCursor": "example",
        "total": 1
      }
    }
  }
}

List profiles

List profiles.

Inputs

Sortsortlist
comma-separated list of sort expressions; resources will be sorted as specifiedOne or more of: name, -name, profileType, -profileType, profileState, -profileState, id, -id.
Limitlimitnumber
maximum resources per pageAt most 200.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "links": {
      "first": "example",
      "next": "example",
      "self": "example"
    },
    "meta": {
      "paging": {
        "limit": 1,
        "nextCursor": "example",
        "total": 1
      }
    }
  }
}

List users

List users.

Inputs

Sortsortlist
comma-separated list of sort expressions; resources will be sorted as specifiedOne or more of: username, -username, lastName, -lastName.
Limitlimitnumber
maximum resources per pageAt most 200.

Outputs

dataobject
The service response, including pagination metadata when present.
Example output
{
  "data": {
    "data": [],
    "included": [],
    "links": {
      "first": "example",
      "next": "example",
      "self": "example"
    },
    "meta": {
      "paging": {
        "limit": 1,
        "nextCursor": "example",
        "total": 1
      }
    }
  }
}

On this page