GET accounts/:account_id/promoted_accounts

Retrieve references to the Promoted Accounts associated with one or more line items.

Use GET users/lookup to obtain user data for the user accounts identified by user_id in the response.

Note: An HTTP 400 will be returned if none of the specified line items are configured to contain Promoted Accounts.

Resource URL

Resource Information

Response formats JSON
Requires authentication? Yes (user context only)
Rate limited? Yes


Name Required Description Default Value Example
account_id required The identifier for the leveraged account. Appears within the resource’s path and is generally a required parameter for all Advertising API requests excluding GET accounts . The specified account must be associated with the authenticating user.   43853bhii879
line_item_id optional A reference to the line item you are operating with in the request. Omitting the line_item_id will return all promoted accounts across all campaigns.   43853bh6lk3n
promoted_account_ids optional Scope the response to the specified, comma-separated list of promoted account IDs. These identifiers refer to a associated Promoted Account with a line item. This comes from the id field from a response item to GET accounts/:account_id/promoted_accounts. Supplied within the resource’s path.   1wxdf8juj8yh
with_deleted optional Include deleted results in your request. false true
count optional Specifies the number of Promoted Accounts to try to retrieve, up to a maximum of 1000 per distinct request.    
cursor optional Specifies a cursor to get the next page of Promoted Accounts. See Pagination for more information.   gc-ddf4a
sort_by optional Sorts by supported attribute in ascending or descending order. See Sorting for more information.   created_at-asc, updated_at-desc
draft_only optional Scope the response to Promoted Accounts under draft campaigns. false true

Example Request


Example Response

    "request": {
      "params": {
        "line_item_id": "5woz",
        "account_id": "hkk5"
    "data": [
        "line_item_id": "5woz",
        "user_id": "6253282",
        "id": "2iu7",
        "paused": false,
        "created_at": "2012-11-30T22:58:11Z",
        "updated_at": "2012-11-30T22:58:11Z",
        "approval_status": "ACCEPTED",
        "deleted": false
    "data_type": "promotable_account",
    "total_count": 1,
    "next_cursor": null