Organizations can hold one or more ad accounts. Each ad account represents the advertiser or brand running ads, and acts as the container for its campaigns, event groups, custom audiences, creatives, billing, and reporting.
Access to the Ads API is governed at the organization level: access tokens are scoped to an organization, and roles are assigned to developers for one or more ad accounts within it. A single organization can have multiple ad accounts, and a developer's access depends on their assigned permissions.
Each ad account has a unique identifier (uid). To make some calls, like creating a custom audience, you need to specify this uid. For other calls, like GET List campaigns, you can use the uid as a filter.
List accounts
To retrieve all accounts you have access to, make a GET List accounts call. The response returns a list of accounts along with a count and total_count, which indicate the number of accounts received and the total number of accounts available, respectively.
The following query parameters are available:
| Parameter | Type | Description |
|---|---|---|
uid | array of strings | A set of unique identifiers to retrieve. Use this to fetch one or more specific accounts by uid. |
limit | number | The maximum number of results to return. Default: 20. |
offset | number | The starting position of results. Use in conjunction with limit to paginate through results. For example, a limit of 2 and an offset of 10 returns items 11–12. Default: 0. |
Get an account
To retrieve a single account, make a GET Get an account call and pass the account's uid as a path parameter. A successful call returns the account specified by its unique identifier. If the uid doesn't exist or you don't have access to it, the API returns a 403 status.
A successful call returns:
datatype— The resource type; always"account".uid— The unique identifier of the account.
data.attributesname- The name of the account.organization_uid- The unique identifier of the organization that the account belongs to.currency- The currency used by the account, formatted as a full display name string (e.g.“United States Dollar").country- The country associated with the account, formatted as a full country name string (e.g.“United States").content_category- The content category associated with the account.timezone- The timezone used by the account, in IANA timezone format (e.g.”America/Los_Angeles”).website_url- The URL of the advertiser’s website.created_at- The date and time the account was created, in ISO-8601 format.updated_at- The date and time the account was last updated, in ISO-8601 format.