Apple Search Ads Credentials

Apple Search Ads credentials are created in the Search Ads account, not in App Store Connect. A Search Ads API key gives Appeeky access to the campaigns and reports for the selected organization.

Apple Search Ads API keys are separate from App Store Connect API keys. A working App Store Connect key cannot be used for Search Ads campaigns.

Create a Search Ads API Key

Sign in at searchads.apple.com.
Open Account Settings > API or User Management > API. The label can vary by account layout.
Generate an API client.
Upload your public key. Apple expects an EC P-256 key pair, similar to App Store Connect.
Save these values:
- Client ID: usually starts with SEARCHADS.
- Team ID: often the same value as Client ID
- Key ID
- Org ID: numeric Search Ads organization ID
- Private key: .p8 PEM, shown or downloaded once

Apple’s reference: Implementing OAuth for the Apple Search Ads API.

Save the private key immediately. Apple may only show or download it once.

Connect Credentials

curl

curl -X POST "https://api.appeeky.com/v1/connect/apple-ads/credentials" \
  -H "X-API-Key: YOUR_APPEEKY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "SEARCHADS.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "teamId": "SEARCHADS.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "keyId": "c60fc276-80a7-440d-b800-f13a7dcc6fde",
    "orgId": "21106140",
    "privateKey": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----"
  }'

Field	Required	Description
`clientId`	Yes	Search Ads API client ID
`teamId`	Yes	Search Ads team ID
`keyId`	Yes	API key ID
`orgId`	Yes	Numeric Search Ads organization ID
`privateKey`	Yes	EC private key PEM

Appeeky validates credentials against Apple before saving them. Saved credentials are stored securely and encrypted at rest.

Check Connection Status

curl

curl "https://api.appeeky.com/v1/connect/apple-ads/credentials/status" \
  -H "X-API-Key: YOUR_APPEEKY_KEY"

Example response:

{
  "data": {
    "connected": true,
    "clientId": "SEARCHADS.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "teamId": "SEARCHADS.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "orgId": "21106140",
    "keyId": "c60fc276-80a7-440d-b800-f13a7dcc6fde",
    "lastVerifiedAt": "2026-06-09T12:00:00Z"
  }
}

Verify Account Access

Current API User

curl

curl "https://api.appeeky.com/v1/connect/apple-ads/me" \
  -H "X-API-Key: YOUR_APPEEKY_KEY"

Accessible Organizations

curl

curl "https://api.appeeky.com/v1/connect/apple-ads/acls" \
  -H "X-API-Key: YOUR_APPEEKY_KEY"

Use /acls to confirm which Search Ads organizations the API key can access and which roles Apple assigned.

Disconnect

curl

curl -X DELETE "https://api.appeeky.com/v1/connect/apple-ads/credentials" \
  -H "X-API-Key: YOUR_APPEEKY_KEY"

This removes the saved Search Ads connection from Appeeky.

Authentication Options

Stored Credentials

Connect once with:

POST /v1/connect/apple-ads/credentials

After that, data requests only need your Appeeky API key. This is recommended for production and for MCP tools.

Per-Request Headers

For one-off calls or tests, pass Search Ads credentials on every request:

Header	Required	Description
`X-ASA-Client-Id`	Yes	Search Ads Client ID
`X-ASA-Team-Id`	Yes	Team ID
`X-ASA-Key-Id`	Yes	API Key ID
`X-ASA-Org-Id`	Yes	Organization ID
`X-ASA-Private-Key`	Yes*	Private key PEM
`X-ASA-Private-Key-B64`	Yes*	Base64-encoded PEM alternative

* Provide either X-ASA-Private-Key or X-ASA-Private-Key-B64.

curl

curl "https://api.appeeky.com/v1/connect/apple-ads/campaigns" \
  -H "X-API-Key: YOUR_APPEEKY_KEY" \
  -H "X-ASA-Client-Id: SEARCHADS.xxx" \
  -H "X-ASA-Team-Id: SEARCHADS.xxx" \
  -H "X-ASA-Key-Id: your-key-id" \
  -H "X-ASA-Org-Id: 21106140" \
  -H "X-ASA-Private-Key: -----BEGIN PRIVATE KEY-----..."

Plan Requirement

Apple Search Ads requires Indie plan or higher. If connection fails with PLAN_REQUIRED, upgrade the account or use an API key tied to an eligible Appeeky account.

Troubleshooting

Error	Meaning	Fix
`MISSING_FIELDS`	Connect body is missing required Search Ads fields	Send `clientId`, `teamId`, `keyId`, `orgId`, and `privateKey`
`INVALID_ASC_CREDENTIALS`	Apple rejected the Search Ads OAuth credentials	Recreate the Search Ads API key and verify the org ID
`ASA_CREDENTIALS_REQUIRED`	No saved credentials and no `X-ASA-*` headers	Connect credentials once or pass per-request headers
`PLAN_REQUIRED`	Account is not on an eligible plan	Use an eligible Appeeky account
Apple 403	API key has no access to that organization or route	Check Search Ads roles and `/acls`

Getting Started

Apps

My Data - Appeeky Web

Keywords

ASO Tools

AI Visibility

Search & Discovery

Market Intelligence

RevenueCat

App Store Connect

Google Play Console

Apple Search Ads

Growth Channels

Reference

Create a Search Ads API Key

Connect Credentials

Check Connection Status

Verify Account Access

Current API User

Accessible Organizations

Disconnect

Authentication Options

Stored Credentials

Per-Request Headers

Plan Requirement

Troubleshooting

​Create a Search Ads API Key

​Connect Credentials

​Check Connection Status

​Verify Account Access

​Current API User

​Accessible Organizations

​Disconnect

​Authentication Options

​Stored Credentials

​Per-Request Headers

​Plan Requirement

​Troubleshooting

Create a Search Ads API Key

Connect Credentials

Check Connection Status

Verify Account Access

Current API User

Accessible Organizations

Disconnect

Authentication Options

Stored Credentials

Per-Request Headers

Plan Requirement

Troubleshooting