Skip to main content


Note: This method is only available for select partners who have been approved for the eBay priority strategy program. For information about how to request access to this program, refer to Priority Strategy Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for priority strategy, use the getAdvertisingEligibility method in Account API.
This method retrieves details on a specific keyword from an ad group within a priority strategy campaign that uses the Cost Per Click (CPC) funding model.

In the request, specify the campaign_id and keyword_id as path parameters.

Call the getCampaigns method to retrieve a list of current campaign IDs for a seller and call the getKeywords method to retrieve their keyword IDs.


Resource URI


This method is supported in Sandbox environment. To access the endpoint, just replace the root URI with

URI parameters

campaign_idstringThis path parameter specifies the unique eBay-assigned identifier of the ad campaign associated with the keyword being retrieved.

Use the getCampaigns method to retrieve campaign IDs.

Occurrence: Required

keyword_idstringThis path parameter specifies the unique identifier of the keyword being retrieved.

Use the getKeywords method to retrieve keyword IDs.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.


HTTP response headers

This call has no response headers.

Response payload

Response fields

Output container/fieldTypeDescription

This field identifies the ad group that the keyword is associated with.

Occurrence: Always


The bid associated with the keyword. This container will not be returned if the keyword does not have a defined bid value.

Occurrence: Conditional


The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD

Occurrence: Conditional


The monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional


The unique identifier of a keyword.

Occurrence: Always


The status of the keyword.

Valid Values:


Occurrence: Always


The text of the keyword.

Occurrence: Always


A field that defines the match type for the keyword.

Valid Values:


Occurrence: Always

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

404Not Found
409Business error
500Internal Server error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

35001API_MARKETINGAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
35002API_MARKETINGAPPLICATIONInternal error. Please wait a few minutes and try the call again.
35045API_MARKETINGREQUESTNo campaign found for campaign id {campaign_id}.
35129API_MARKETINGBUSINESSThis method is not supported for campaigns with smart targeting type.
36310API_MARKETINGREQUESTNo keyword found for keyword id {keyword_id}.


This call has no warnings.


New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Retrieve Keyword Details

This example retrieves the details for a specific keyword from an ad group within a Promoted Listings priority strategy campaign.


The inputs for this sample are the campaign_id of the ad campaign with which the keyword is associated, as well as the keyword_id of the keyword for which the details shall be retrieved.



If the call is successful, the details for the specified keyword are returned.

Got thoughts? Click the feedback button – your insights help us improve!