Contents

Read an app’s encryption declarations

Find and list all available app encryption declarations.

URL

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

Path Parameters

NameTypeDescription
id Requiredstring

An opaque resource ID that uniquely identifies the resource. Obtain the app resource ID from the List apps response.

Query Parameters

NameTypeDescription
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 Optionalinteger

The maximum number of app encryption declaration resources to return.

limit[builds] Optionalinteger

The maximum number of related builds resources to return.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
AppEncryptionDeclarationsResponse

400Bad Request
Content-Type: application/json
ErrorResponse

401Unauthorized
Content-Type: application/json
ErrorResponse

403Forbidden
Content-Type: application/json
ErrorResponse

404Not Found
Content-Type: application/json
ErrorResponse

429
Content-Type: application/json
ErrorResponse

Mentioned in

See Also

Getting App Encryption Declarations