Org
Represents an organization in the Apple Ads system.
Declaration
object OrgProperties
| Name | Type | Description |
|---|---|---|
name | string | The name of the organization. |
currency | Org.Currency | The currency used by the organization. See Org.Currency. |
timezone | string | The timezone associated with the organization. |
paymentModel | Org.PaymentModel | The payment model for the organization. |
systemStatus | Org.SystemStatus | The system-assigned status of the organization. See Org.SystemStatus. |
systemStatusReasons | [Org.SystemStatusReasons] | Reasons associated with the current system status. See Org.SystemStatusReasons. |
id | int64 | The unique identifier for the organization. |
Discussion
An Org is the top-level entity that owns ad accounts, manages users, and groups all advertising activity under a single billing relationship. It’s the root entity in the account hierarchy, with ad accounts, campaigns, and user memberships all existing beneath it.
The systemStatus field reflects whether the org is ACTIVE or INACTIVE. An inactive org prevents all campaigns under it from serving. Check systemStatusReasons for the specific cause.
To discover which organizations the current API token can access, use GET /v1/acls (Get User ACL). Then, to retrieve full details, use GET /v1/orgs/{orgId} (Get Org by ID).
Example
{
"name": "AwayFinder",
"currency": "USD",
"timezone": "America/Los_Angeles",
"paymentModel": "PAYG",
"systemStatus": "ACTIVE",
"systemStatusReasons": [],
"id": 123456789
}