WOworkiz
AdGroups

Retrieve a list of Ad Groups

Changed on

Retrieves a paginated list of Ad Groups.

get/v2/adgroups

Request

Query parameters

pageSizenumber
Example:10

Number of records to return per page.

pagenumber
Example:1

The page index.

disabledboolean

Filter by disabled state. When true, returns only disabled ad groups; when false, returns only enabled ad groups.

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

A paginated list of Ad Groups.

pageSizenumber

The maximum number of items returned per page.

pagenumber

The current page number.

totalResultsnumber

The total number of results.

hasMoreboolean

Whether there are more results.

Example response

{
  "pageSize": 10,
  "page": 1,
  "totalResults": 50,
  "hasMore": true,
  "data": [
    {
      "id": "AG-71b8d7310acbf8cc",
      "name": "Group A",
      "displayOrder": 1,
      "description": "This is a sample ad group."
    }
  ]
}

Changes

  • a2110eaa32f2Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • c308fa019f29Revision changes
    • info

      added the new optional query request parameter disabled

    • info

      added the non-success response with the status