Get a Keyword
Retrieve a single keyword by its unique identifier.
URL
GET https://api.ads.apple.com/v1/keywords/{id}Path Parameters
| Name | Type | Description |
|---|---|---|
id Required | string |
Header Parameters
| Name | Type | Description |
|---|---|---|
X-Ap-Context Required | string |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | KeywordResponse | |
| 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 keyword by its ID. The response includes all keyword fields plus displayStatus, which reflects the combined delivery state of the keyword, its ad group, and its campaign.
Deleted keywords remain retrievable and only the query endpoint supports listing multiple records.
Constraint | Detail |
|---|---|
Deleted keywords are returned | A deleted keyword is returned with |
Deleted keywords excluded from query results |
|
Use query endpoint for listing |
|
| The parent hierarchy IDs are always present in the response. |