Contents

Get User ACL

Return the ad accounts and roles accessible to the authenticated API caller.

URL

GET https://api.ads.apple.com/v1/acls

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
UserAclListResponse

Successful operation. Returns UserAclListResponse (result: UserAccessResult).

400Bad Request
Content-Type: application/json
Error

Bad Request. Returns ErrorResponse.

401Unauthorized
Content-Type: application/json
Error

Unauthorized.

403Forbidden
Content-Type: application/json
Error

Forbidden.

404Not Found
Content-Type: application/json
Error

Resource not found. Returns ErrorResponse.

429Too Many Requests
Content-Type: application/json
Error

Rate Limit Exceeded. See Applying Rate Limits.

500Internal Server Error
Content-Type: application/json
Error

Internal Server Error. Returns ErrorResponse.

Discussion

This endpoint retrieves a UserAclListResponse for the authenticated user. The response contains a result object with an acls array. Each UserAcl entry contains an adAccount object and a roles array listing the roles the user holds for that account.

To discover which ad accounts an API token can access and what permission level applies, use this endpoint at the start of a session. Each access token binds to exactly one org. The orgId on every returned adAccount will be the same.

Payload Examples

See Also