Get an Ad Group

Retrieve a single ad group by its unique identifier.

URL

GET https://api.ads.apple.com/v1/adgroups/{id}

Path Parameters

Name	Type	Description
`id` Required	string

Header Parameters

Name	Type	Description
`X-Ap-Context` Required	string

Response Codes

Status	Reason	Type
200	OK Content-Type: application/json	`AdGroupResponse`
400	Bad Request Content-Type: application/json	`ErrorResponse`
401	Unauthorized Content-Type: application/json	`ErrorResponse`
403	Forbidden Content-Type: application/json	`ErrorResponse`
404	Not Found Content-Type: application/json	`ErrorResponse`
429	Too Many Requests Content-Type: application/json	`ErrorResponse`
500	Internal Server Error Content-Type: application/json	`ErrorResponse`

Discussion

This endpoint retrieves a single ad group by its ID. The response includes all fields set at creation and any values modified since, including the full targeting and bidStrategy nested objects.

The response includes the following status fields:

Field	Type	Description
`status`	string	Advertiser-managed state: `ENABLED` or `PAUSED`.
`systemStatus`	string	System-computed: `RUNNING` or `NOT_RUNNING`. When `NOT_RUNNING`, inspect `systemStatusReasons`.
`displayStatus`	string	System-computed, rolled-up delivery state. See Adgroupdisplaystatus.

Keep the following constraints in mind when reading a GET response:

Constraint	Detail
Deleted ad groups are returned	The API returns a deleted ad group with `deleted: true` and does not remove the record from GET by ID responses.
`campaignId` is always returned	The parent campaign ID is always present in the response.
Use query endpoint for listing	`GET /adgroups/{id}` returns a single record. Use `POST /adgroups/query` to filter and list multiple ad groups.

Get an Ad Group

URL

Path Parameters

Header Parameters

Response Codes

Discussion

Payload Examples

See Also