Contents

Get a Negative Keyword

Retrieve a single negative keyword by its unique identifier.

URL

GET https://api.ads.apple.com/v1/negative-keywords/{id}

Path Parameters

NameTypeDescription
id Requiredstring

Header Parameters

NameTypeDescription
X-Ap-Context Requiredstring

Response Codes

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

Discussion

This endpoint retrieves a single negative keyword by its ID. The response indicates whether the record is a campaign-level or ad-group-level exclusion based on the presence of the adGroupId field. Campaign-level negatives don’t include adGroupId in the response. Ad-group-level negatives include it.

The presence of adGroupId in the response distinguishes which level the negative keyword applies to.

Condition

Level

adGroupId is absent from the response

Campaign-level negative keyword: applies to all ad groups in the campaign

adGroupId is present in the response

Ad-group-level negative keyword: scoped to a single ad group

Deleted negative keywords remain retrievable by ID and never expose a bid field.

Constraint

Detail

Deleted negative keywords are returned

A deleted negative keyword is returned with deleted: true. The record is not removed from GET by ID responses.

Use query endpoint for listing

GET /negative-keywords/{id} returns a single record. Use POST /negative-keywords/query to filter and list.

No bid field

Negative keywords never have a bid field in the response.

Payload Examples

See Also