Read an app’s encryption declarations
Find and list all available app encryption declarations.
URL
GET https://api.appstoreconnect.apple.com/v1/apps/{id}/appEncryptionDeclarationsPath Parameters
| Name | Type | Description |
|---|---|---|
id Required | string | An opaque resource ID that uniquely identifies the resource. Obtain the app resource ID from the List apps response. |
Query Parameters
| Name | Type | Description |
|---|---|---|
fields[appEncryptionDeclarationDocuments] Optional | [string] | Additional fields to include for each app encryption declaration document resource returned by the response. |
fields[appEncryptionDeclarations] Optional | [string] | Additional fields to include for each app encryption declaration resource returned by the response. |
fields[apps] Optional | [string] | Additional fields to include for each app resource returned by the response. |
fields[builds] Optional | [string] | Additional fields to include for each build resource returned by the response. |
filter[builds] Optional | [string] | Filter the returned app encryption declarations by builds. |
filter[platform] Optional | [string] | Filter the returned app encryption declarations by platform. |
include Optional | [string] | The relationship data to include in the response. |
limit Optional | integer | The maximum number of app encryption declaration resources to return. |
limit[builds] Optional | integer | The maximum number of related builds resources to return. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | AppEncryptionDeclarationsResponse | |
| 400 | Bad Request Content-Type: application/json | ErrorResponse | |
| 401 | Unauthorized Content-Type: application/json | ErrorResponse | |
| 403 | Forbidden Content-Type: application/json | ErrorResponse | |
| 404 | Not Found Content-Type: application/json | ErrorResponse | |
| 429 | Content-Type: application/json | ErrorResponse |
Mentioned in
See Also
Getting App Encryption Declarations
List app encryption declarationsRead app encryption declaration informationRead an app’s encryption declaration idsRead the app information of an app encryption declarationRead the App ID of an App Encryption DeclarationRead a specific app encryption declaration documentRead the declaration document for an app encryption declarationRead the App ID of an App Encryption DeclarationRead the ID of the Document for an App Encryption Declaration