{"abstract":[{"text":"Authenticate your requests, scope them to an ad account, and apply role-based access levels.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.apple.documentation\/documentation\/technologies","doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API"]]},"identifier":{"interfaceLanguage":"data","url":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/access-overview"},"kind":"article","legalNotices":{"copyright":"Copyright &copy; 2026 Apple Inc. All rights reserved.","privacyPolicy":"https:\/\/www.apple.com\/privacy\/privacy-policy","termsOfUse":"https:\/\/www.apple.com\/legal\/internet-services\/terms\/site.html"},"metadata":{"availableLanguages":["de-DE","en-US","es-419","fr-FR","it-IT","ja-JP","ko-KR","pt-BR","zh-CN"],"modules":[{"name":"Apple Ads Platform API"}],"platforms":[{"introducedAt":"1.0","name":"Apple Ads Platform API"}],"role":"article","roleHeading":"Article","title":"Managing Ad Accounts and API Access"},"primaryContentSections":[{"content":[{"anchor":"Overview","level":2,"text":"Overview","type":"heading"},{"inlineContent":[{"text":"Obtain an access token via the Apple Ads OAuth2 flow. Pass it as:","type":"text"}],"type":"paragraph"},{"code":["Authorization: Bearer <access_token>"],"copyToClipboard":true,"lineAnnotations":[],"showLineNumbers":false,"syntax":null,"type":"codeListing","wrap":0},{"inlineContent":[{"text":"See ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/implementing-oauth-for-the-apple-ads-platform-api","isActive":true,"type":"reference"},{"text":" for the full OAuth setup walkthrough.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"All ad account scoped endpoints require an ","type":"text"},{"code":"X-AP-Context","type":"codeVoice"},{"text":" header that identifies the ad account you’re accessing:","type":"text"}],"type":"paragraph"},{"code":["X-AP-Context: adAccountId=<id>"],"copyToClipboard":true,"lineAnnotations":[],"showLineNumbers":false,"syntax":null,"type":"codeListing","wrap":0},{"inlineContent":[{"text":"You don’t need the header for ","type":"text"},{"code":"GET \/v1\/me","type":"codeVoice"},{"text":" (","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-current-user-details","isActive":true,"type":"reference"},{"text":"), ","type":"text"},{"code":"GET \/v1\/acls","type":"codeVoice"},{"text":" (","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-user-ACLs","isActive":true,"type":"reference"},{"text":"), ","type":"text"},{"code":"GET \/v1\/orgs\/{id}","type":"codeVoice"},{"text":" (","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/GET-orgs-_id_","isActive":true,"type":"reference"},{"text":"), ","type":"text"},{"code":"GET \/v1\/advertiser-resources","type":"codeVoice"},{"text":" (","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-advertiser-resources","isActive":true,"type":"reference"},{"text":"), or ","type":"text"},{"code":"POST \/v1\/ad-accounts","type":"codeVoice"},{"text":" (","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/POST-ad-accounts","isActive":true,"type":"reference"},{"text":").","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"Budget order endpoints are scoped to the organization. See ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/budget-orders-endpoints","isActive":true,"type":"reference"},{"text":" for when to send the header.","type":"text"}],"type":"paragraph"},{"anchor":"Explore-the-Account-Management-Endpoints","level":2,"text":"Explore the Account Management Endpoints","type":"heading"},{"inlineContent":[{"text":"The following endpoints handle authentication, ad account management, and access control:","type":"text"}],"type":"paragraph"},{"header":"row","rows":[[[{"inlineContent":[{"text":"Method","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"text":"Path","type":"text"}],"type":"paragraph"}],[{"inlineContent":[{"text":"Description","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"GET","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"\/v1\/me","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-current-user-details","isActive":true,"type":"reference"},{"text":" returns the userId and orgId for the authenticated caller.","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"POST","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"\/v1\/ad-accounts","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/POST-ad-accounts","isActive":true,"type":"reference"},{"text":" creates a new ad account under a specified org.","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"GET","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"\/v1\/ad-accounts\/{id}","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/GET-ad-accounts-_id_","isActive":true,"type":"reference"},{"text":" retrieves full details for a specific ad account.","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"PUT","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"\/v1\/ad-accounts\/{id}","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/PUT-ad-accounts-_id_","isActive":true,"type":"reference"},{"text":" updates an ad account’s name or delegations.","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"GET","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"\/v1\/advertiser-resources","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-advertiser-resources","isActive":true,"type":"reference"},{"text":" retrieves the advertiser resources (brands, content providers) eligible to be delegated to an ad account.","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"GET","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"\/v1\/acls","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-user-ACLs","isActive":true,"type":"reference"},{"text":" returns a list of ad accounts and roles accessible to the authenticated caller.","type":"text"}],"type":"paragraph"}]],[[{"inlineContent":[{"code":"GET","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"code":"\/v1\/orgs\/{id}","type":"codeVoice"}],"type":"paragraph"}],[{"inlineContent":[{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/GET-orgs-_id_","isActive":true,"type":"reference"},{"text":" retrieves the details of a specific organization by its ID.","type":"text"}],"type":"paragraph"}]]],"type":"table"},{"anchor":"Make-Your-First-API-Call","level":2,"text":"Make Your First API Call","type":"heading"},{"inlineContent":[{"text":"This walkthrough takes you from an access token to a real ad account response, start to finish.","type":"text"}],"type":"paragraph"},{"anchor":"Get-an-Access-Token","level":3,"text":"Get an Access Token","type":"heading"},{"inlineContent":[{"text":"Request a token from the authorization server using the client credentials you set up in ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/implementing-oauth-for-the-apple-ads-platform-api","isActive":true,"type":"reference"},{"text":":","type":"text"}],"type":"paragraph"},{"code":["curl -X POST \"https:\/\/appleid.apple.com\/auth\/oauth2\/token\" \\","  -H \"Host: appleid.apple.com\" \\","  -H \"Content-Type: application\/x-www-form-urlencoded\" \\","  -d \"grant_type=client_credentials\" \\","  -d \"client_id={client_id}\" \\","  -d \"client_secret={client_secret}\" \\","  -d \"scope=searchadsorg\""],"copyToClipboard":true,"lineAnnotations":[],"showLineNumbers":false,"syntax":"console","type":"codeListing","wrap":0},{"inlineContent":[{"text":"The server returns:","type":"text"}],"type":"paragraph"},{"code":["{","  \"access_token\": \"{access_token}\",","  \"token_type\": \"Bearer\",","  \"expires_in\": 3600,","  \"scope\": \"searchadsorg\"","}"],"copyToClipboard":true,"lineAnnotations":[],"showLineNumbers":false,"syntax":"json","type":"codeListing","wrap":0},{"inlineContent":[{"text":"Save ","type":"text"},{"code":"access_token","type":"codeVoice"},{"text":". Every call below sends it as ","type":"text"},{"code":"Authorization: Bearer {access_token}","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"},{"anchor":"Confirm-Your-User-and-Org","level":3,"text":"Confirm Your User and Org","type":"heading"},{"inlineContent":[{"text":"The ","type":"text"},{"code":"GET \/v1\/me","type":"codeVoice"},{"text":" (","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-current-user-details","isActive":true,"type":"reference"},{"text":") endpoint doesn’t require an ","type":"text"},{"code":"X-AP-Context","type":"codeVoice"},{"text":" header, so you can call it right after you get your token:","type":"text"}],"type":"paragraph"},{"code":["curl \"https:\/\/api.ads.apple.com\/v1\/me\" \\","  -H \"Authorization: Bearer {access_token}\""],"copyToClipboard":true,"lineAnnotations":[],"showLineNumbers":false,"syntax":"console","type":"codeListing","wrap":0},{"inlineContent":[{"text":"The response includes your ","type":"text"},{"code":"userId","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"orgId","type":"codeVoice"},{"text":":","type":"text"}],"type":"paragraph"},{"code":["{","  \"result\": {","    \"userId\": 3962840,","    \"orgId\": 27154130","  }","}"],"copyToClipboard":true,"lineAnnotations":[],"showLineNumbers":false,"syntax":"json","type":"codeListing","wrap":0},{"anchor":"Discover-Your-Ad-Accounts","level":3,"text":"Discover Your Ad Accounts","type":"heading"},{"inlineContent":[{"text":"The ","type":"text"},{"code":"GET \/v1\/acls","type":"codeVoice"},{"text":" (","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-user-ACLs","isActive":true,"type":"reference"},{"text":") endpoint also doesn’t require an ","type":"text"},{"code":"X-AP-Context","type":"codeVoice"},{"text":" header. It returns every ad account your token can access and your role on each one:","type":"text"}],"type":"paragraph"},{"code":["curl \"https:\/\/api.ads.apple.com\/v1\/acls\" \\","  -H \"Authorization: Bearer {access_token}\""],"copyToClipboard":true,"lineAnnotations":[],"showLineNumbers":false,"syntax":"console","type":"codeListing","wrap":0},{"inlineContent":[{"text":"The response lists each accessible ad account alongside your roles:","type":"text"}],"type":"paragraph"},{"code":["{","  \"result\": {","    \"acls\": [","      {","        \"adAccount\": {","          \"id\": 123456789,","          \"name\": \"AwayFinder\",","          \"orgId\": 27154130","        },","        \"roles\": [\"Admin\"]","      }","    ]","  }","}"],"copyToClipboard":true,"lineAnnotations":[],"showLineNumbers":false,"syntax":"json","type":"codeListing","wrap":0},{"inlineContent":[{"text":"Save the ","type":"text"},{"code":"adAccount.id","type":"codeVoice"},{"text":" you want to work with. That value is your ","type":"text"},{"code":"adAccountId","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"If ","type":"text"},{"code":"acls","type":"codeVoice"},{"text":" comes back empty, your org has no ad accounts yet. See “Create an Ad Account” further down this page, then return here with the new account’s ","type":"text"},{"code":"id","type":"codeVoice"},{"text":" before continuing to Make Your First Ad Account Scoped Call.","type":"text"}],"type":"paragraph"},{"anchor":"Make-Your-First-Ad-Account-Scoped-Call","level":3,"text":"Make Your First Ad Account Scoped Call","type":"heading"},{"inlineContent":[{"text":"The ","type":"text"},{"code":"GET \/v1\/ad-accounts\/{id}","type":"codeVoice"},{"text":" (","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/GET-ad-accounts-_id_","isActive":true,"type":"reference"},{"text":") endpoint is ad account scoped, so it requires the ","type":"text"},{"code":"X-AP-Context","type":"codeVoice"},{"text":" header set to the ","type":"text"},{"code":"adAccountId","type":"codeVoice"},{"text":" from Discover Your Ad Accounts, above:","type":"text"}],"type":"paragraph"},{"code":["curl \"https:\/\/api.ads.apple.com\/v1\/ad-accounts\/123456789\" \\","  -H \"Authorization: Bearer {access_token}\" \\","  -H \"X-AP-Context: adAccountId=123456789\""],"copyToClipboard":true,"lineAnnotations":[],"showLineNumbers":false,"syntax":"console","type":"codeListing","wrap":0},{"inlineContent":[{"text":"The response returns the full ad account record:","type":"text"}],"type":"paragraph"},{"code":["{","  \"result\": {","    \"id\": 123456789,","    \"name\": \"AwayFinder Ad Account\",","    \"orgId\": 27154130,","    \"timezone\": \"America\/New_York\",","    \"currency\": \"USD\",","    \"paymentModel\": \"PAYG\",","    \"systemStatus\": \"ACTIVE\",","    \"systemStatusReasons\": [],","    \"productFeatures\": [\"APPSTORE_APP_MANUAL\"],","    \"delegations\": [","      {","        \"resourceId\": \"12345678\",","        \"resourceType\": \"CONTENT_PROVIDER\",","        \"resourceName\": \"AwayFinder Apps\"","      }","    ],","    \"creationTime\": \"2025-01-10T08:00:00.000\",","    \"modificationTime\": \"2025-01-10T08:00:00.000\"","  }","}"],"copyToClipboard":true,"lineAnnotations":[],"showLineNumbers":false,"syntax":"json","type":"codeListing","wrap":0},{"inlineContent":[{"text":"You now have a ","type":"text"},{"code":"userId","type":"codeVoice"},{"text":", ","type":"text"},{"code":"orgId","type":"codeVoice"},{"text":", and ","type":"text"},{"code":"adAccountId","type":"codeVoice"},{"text":", and you’ve made a real, authenticated, ad account scoped call. From here:","type":"text"}],"type":"paragraph"},{"items":[{"content":[{"inlineContent":[{"text":"To find the brands or content providers available across your org and identify which one to delegate to an account, use ","type":"text"},{"code":"GET \/v1\/advertiser-resources?resourceType=<type>","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"text":"Every response above also includes ","type":"text"},{"code":"RateLimit-*","type":"codeVoice"},{"text":" headers you can use to pace requests before hitting a ","type":"text"},{"code":"429","type":"codeVoice"},{"text":". See ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/rate-limits","isActive":true,"type":"reference"},{"text":" for the full header reference and a sample backoff implementation.","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"text":"Ready to build a campaign? Follow the ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/journey-app-store-ads","isActive":true,"type":"reference"},{"text":" or ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/journey-apple-maps-brand-ads","isActive":true,"type":"reference"},{"text":" journey guide next.","type":"text"}],"type":"paragraph"}]}],"type":"unorderedList"},{"anchor":"Understand-the-Organization-Hierarchy","level":2,"text":"Understand the Organization Hierarchy","type":"heading"},{"inlineContent":[{"text":"An Org (organization) is the top-level owner. Each Org can have multiple Ad Accounts. Delegations attach advertiser resources (brands, content providers) to ad accounts.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"The API uses a three-level hierarchy: ","type":"text"},{"inlineContent":[{"text":"Org","type":"text"}],"type":"strong"},{"text":" → ","type":"text"},{"inlineContent":[{"text":"Ad Accounts","type":"text"}],"type":"strong"},{"text":" → ","type":"text"},{"inlineContent":[{"text":"Campaigns","type":"text"}],"type":"strong"},{"text":". Each ad account belongs to exactly one org, and that relationship is immutable.","type":"text"}],"type":"paragraph"},{"anchor":"Understand-Ad-Account-Product-Features","level":2,"text":"Understand Ad Account Product Features","type":"heading"},{"inlineContent":[{"text":"Each ad account carries a ","type":"text"},{"code":"productFeatures","type":"codeVoice"},{"text":" array that determines whether its campaigns can target App Store or Apple Maps.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"App Store ad accounts carry the ","type":"text"},{"code":"APPSTORE_APP_MANUAL","type":"codeVoice"},{"text":" feature. Apple Maps ad accounts carry the ","type":"text"},{"code":"BUSINESS_BRAND_MANUAL","type":"codeVoice"},{"text":" feature. An account authorized for App Store can’t run campaigns on Apple Maps, and vice versa.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"See ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/ProductFeatures","isActive":true,"type":"reference"},{"text":" for a full description of each value.","type":"text"}],"type":"paragraph"},{"anchor":"Create-an-Ad-Account","level":2,"text":"Create an Ad Account","type":"heading"},{"inlineContent":[{"text":"To create an ad account, make a POST request to ","type":"text"},{"code":"\/v1\/ad-accounts","type":"codeVoice"},{"text":". See ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/AdAccountCreate","isActive":true,"type":"reference"},{"text":" for the required parameters. To link the account to an App Store or Apple Maps resource, use ","type":"text"},{"code":"delegations","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"A newly created account receives a ","type":"text"},{"code":"systemStatus","type":"codeVoice"},{"text":" of ","type":"text"},{"code":"ACTIVE","type":"codeVoice"},{"text":" or ","type":"text"},{"code":"INACTIVE","type":"codeVoice"},{"text":". When the status is ","type":"text"},{"code":"INACTIVE","type":"codeVoice"},{"text":", the ","type":"text"},{"code":"systemStatusReasons","type":"codeVoice"},{"text":" array identifies the blocking condition. Campaigns under an inactive account don’t serve until you resolve the blocking condition.","type":"text"}],"type":"paragraph"},{"anchor":"Update-an-Ad-Account","level":2,"text":"Update an Ad Account","type":"heading"},{"inlineContent":[{"text":"To update an ad account, make a PUT request to ","type":"text"},{"code":"\/v1\/ad-accounts\/{id}","type":"codeVoice"},{"text":" with an ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/AdAccountUpdate","isActive":true,"type":"reference"},{"text":" body. The request updates only the fields you include in the body.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"All array fields use full-replacement semantics. If you send a partial array, the system removes any items not included in the request. To add a single item to an array field, retrieve the current array first, then send the complete desired state.","type":"text"}],"type":"paragraph"},{"anchor":"Find-Advertiser-Resources","level":2,"text":"Find Advertiser Resources","type":"heading"},{"inlineContent":[{"text":"Advertiser resources are brands and content providers available across your organization that you can delegate to an ad account. To retrieve the advertiser resources available in your organization, filtered by resource type, use ","type":"text"},{"code":"GET \/v1\/advertiser-resources","type":"codeVoice"},{"text":" (","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-advertiser-resources","isActive":true,"type":"reference"},{"text":"). The ","type":"text"},{"code":"resourceType","type":"codeVoice"},{"text":" query parameter is required. Omitting it returns a validation error.","type":"text"}],"type":"paragraph"},{"anchor":"Retrieve-Access-Control-Lists-ACLs","level":2,"text":"Retrieve Access Control Lists (ACLs)","type":"heading"},{"inlineContent":[{"text":"Call ","type":"text"},{"code":"GET \/v1\/acls","type":"codeVoice"},{"text":" (","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-user-ACLs","isActive":true,"type":"reference"},{"text":") to retrieve the ","type":"text"},{"code":"UserAccessResult","type":"codeVoice"},{"text":" for the authenticated user. Each acl entry (","type":"text"},{"code":"UserAcl","type":"codeVoice"},{"text":") contains:","type":"text"}],"type":"paragraph"},{"items":[{"content":[{"inlineContent":[{"code":"adAccount","type":"codeVoice"},{"text":": the ad account this entry covers","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"code":"roles","type":"codeVoice"},{"text":": the list of role names the user holds for that account","type":"text"}],"type":"paragraph"}]}],"type":"unorderedList"},{"inlineContent":[{"text":"See ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-user-ACLs","isActive":true,"type":"reference"},{"text":" for full request and response details.","type":"text"}],"type":"paragraph"},{"anchor":"Look-Up-Available-Roles","level":2,"text":"Look Up Available Roles","type":"heading"},{"inlineContent":[{"text":"For the full list of ","type":"text"},{"code":"roles","type":"codeVoice"},{"text":" values and their access levels, see ","type":"text"},{"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/UserAcl","isActive":true,"type":"reference"},{"text":".","type":"text"}],"type":"paragraph"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"seeAlsoSections":[{"anchor":"Account-Management","generated":true,"identifiers":["doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/org-me","doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/ad-account-endpoints","doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/account-management-data-objects","doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/account-management-data-types"],"title":"Account Management"}],"variants":[{"paths":["\/documentation\/apple-ads-platform-api\/access-overview"],"traits":[{"interfaceLanguage":"data"}]}],"references":{"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API":{"abstract":[{"text":"Programmatically manage App Store and Apple Maps advertising campaigns through a single RESTful API.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Apple Ads Platform API"}],"role":"collection","title":"Apple Ads Platform API","type":"topic","url":"\/documentation\/apple-ads-platform-api"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/AdAccountCreate":{"abstract":[{"text":"Request body for creating a new ad account under an organization.","type":"text"}],"fragments":[{"kind":"text","text":"object "},{"kind":"identifier","text":"AdAccountCreate"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/AdAccountCreate","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"AdAccountCreate"}],"role":"symbol","title":"AdAccountCreate","type":"topic","url":"\/documentation\/apple-ads-platform-api\/adaccountcreate"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/AdAccountUpdate":{"abstract":[{"text":"The request body you use to update an ad account.","type":"text"}],"fragments":[{"kind":"text","text":"object "},{"kind":"identifier","text":"AdAccountUpdate"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/AdAccountUpdate","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"AdAccountUpdate"}],"role":"symbol","title":"AdAccountUpdate","type":"topic","url":"\/documentation\/apple-ads-platform-api\/adaccountupdate"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/GET-ad-accounts-_id_":{"abstract":[{"text":"Retrieve the full details of a specific ad account by its ID.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/GET-ad-accounts-_id_","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Get Ad Account by ID"}],"role":"symbol","title":"Get Ad Account by ID","type":"topic","url":"\/documentation\/apple-ads-platform-api\/get-ad-accounts-_id_"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/GET-orgs-_id_":{"abstract":[{"text":"Retrieve the details of a specific organization by its ID.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/GET-orgs-_id_","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Get Org by ID"}],"role":"symbol","title":"Get Org by ID","type":"topic","url":"\/documentation\/apple-ads-platform-api\/get-orgs-_id_"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/Get-advertiser-resources":{"abstract":[{"text":"Retrieve the advertiser resources available to your organization, filtered by resource type.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-advertiser-resources","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Get Advertiser Resources"}],"role":"symbol","title":"Get Advertiser Resources","type":"topic","url":"\/documentation\/apple-ads-platform-api\/get-advertiser-resources"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/Get-current-user-details":{"abstract":[{"text":"Return the user ID and organization ID of the authenticated API caller.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-current-user-details","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Get Me Details"}],"role":"symbol","title":"Get Me Details","type":"topic","url":"\/documentation\/apple-ads-platform-api\/get-current-user-details"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/Get-user-ACLs":{"abstract":[{"text":"Return the ad accounts and roles accessible to the authenticated API caller.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/Get-user-ACLs","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Get User ACL"}],"role":"symbol","title":"Get User ACL","type":"topic","url":"\/documentation\/apple-ads-platform-api\/get-user-acls"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/POST-ad-accounts":{"abstract":[{"text":"Create a new ad account under a specified organization.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/POST-ad-accounts","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Create Ad Accounts"}],"role":"symbol","title":"Create Ad Accounts","type":"topic","url":"\/documentation\/apple-ads-platform-api\/post-ad-accounts"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/PUT-ad-accounts-_id_":{"abstract":[{"text":"Update an ad account’s name or delegations.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/PUT-ad-accounts-_id_","kind":"symbol","navigatorTitle":[{"kind":"text","text":"Update Ad Accounts"}],"role":"symbol","title":"Update Ad Accounts","type":"topic","url":"\/documentation\/apple-ads-platform-api\/put-ad-accounts-_id_"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/ProductFeatures":{"abstract":[{"text":"Product features are the advertising capabilities for an ad account.","type":"text"}],"fragments":[{"kind":"text","text":"type "},{"kind":"identifier","text":"ProductFeatures"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/ProductFeatures","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"ProductFeatures"}],"role":"symbol","title":"ProductFeatures","type":"topic","url":"\/documentation\/apple-ads-platform-api\/productfeatures"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/UserAcl":{"abstract":[{"text":"An access control entry for a single ad account that specifies the authenticated user’s assigned roles.","type":"text"}],"fragments":[{"kind":"text","text":"object "},{"kind":"identifier","text":"UserAcl"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/UserAcl","kind":"symbol","navigatorTitle":[{"kind":"text","text":"User ACL"}],"role":"symbol","title":"User ACL","type":"topic","url":"\/documentation\/apple-ads-platform-api\/useracl"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/account-management-data-objects":{"abstract":[{"text":"Reference the data objects for account management, access control, and organization resources.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/account-management-data-objects","kind":"article","role":"collectionGroup","title":"Account Management Data Objects","type":"topic","url":"\/documentation\/apple-ads-platform-api\/account-management-data-objects"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/account-management-data-types":{"abstract":[{"text":"Reference the enumerations and scalar types for account management, access control, and organization resources.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/account-management-data-types","kind":"article","role":"collectionGroup","title":"Account Management Data Types","type":"topic","url":"\/documentation\/apple-ads-platform-api\/account-management-data-types"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/ad-account-endpoints":{"abstract":[{"text":"Create, retrieve, and update ad accounts, and discover delegable advertiser resources.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/ad-account-endpoints","kind":"article","role":"collectionGroup","title":"Ad Account Endpoints","type":"topic","url":"\/documentation\/apple-ads-platform-api\/ad-account-endpoints"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/budget-orders-endpoints":{"abstract":[{"text":"Create, retrieve, update, and delete budget orders through these endpoints.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/budget-orders-endpoints","kind":"article","role":"collectionGroup","title":"Budget Orders Endpoints","type":"topic","url":"\/documentation\/apple-ads-platform-api\/budget-orders-endpoints"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/implementing-oauth-for-the-apple-ads-platform-api":{"abstract":[{"text":"Generate a key pair and request an access token to authenticate with the Apple Ads Platform API.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/implementing-oauth-for-the-apple-ads-platform-api","kind":"article","role":"article","title":"Implementing OAuth for the Apple Ads Platform API","type":"topic","url":"\/documentation\/apple-ads-platform-api\/implementing-oauth-for-the-apple-ads-platform-api"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/journey-app-store-ads":{"abstract":[{"text":"Set up and launch an App Store campaign, from account verification through keyword targeting to performance reporting.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/journey-app-store-ads","kind":"article","role":"article","title":"Advertising Your App on the App Store","type":"topic","url":"\/documentation\/apple-ads-platform-api\/journey-app-store-ads"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/journey-apple-maps-brand-ads":{"abstract":[{"text":"Identify your brand, upload creative assets, build location groups, and create campaigns, ad groups, creatives, and ads to promote it on Apple Maps.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/journey-apple-maps-brand-ads","kind":"article","role":"article","title":"Advertising Your Business on Apple Maps","type":"topic","url":"\/documentation\/apple-ads-platform-api\/journey-apple-maps-brand-ads"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/org-me":{"abstract":[{"text":"Retrieve the authenticated user’s identity, organization details, and ad account access list.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/org-me","kind":"article","role":"collectionGroup","title":"Org & Me Endpoints","type":"topic","url":"\/documentation\/apple-ads-platform-api\/org-me"},"doc://com.apple.apple-ads-platform-api/documentation/Apple-Ads-Platform-API/rate-limits":{"abstract":[{"text":"Track your remaining quota and pace requests.","type":"text"}],"identifier":"doc:\/\/com.apple.apple-ads-platform-api\/documentation\/Apple-Ads-Platform-API\/rate-limits","kind":"article","role":"article","title":"Applying Rate Limits","type":"topic","url":"\/documentation\/apple-ads-platform-api\/rate-limits"},"doc://com.apple.documentation/documentation/technologies":{"abstract":[],"identifier":"doc:\/\/com.apple.documentation\/documentation\/technologies","kind":"technologies","role":"overview","title":"Technologies","type":"topic","url":"\/documentation\/technologies"}}}