This method returns a paginated collection of all supported topics, along with the details for the topics. This information includes supported schema versions, formats, and other metadata for the topics.
Applications can subscribe to any of the topics for a supported schema version and format, limited by the authorization scopes required to subscribe to the topic.
A topic specifies the type of information to be received and the data types associated with an event. An event occurs in the eBay system, such as when a user requests deletion or revokes access for an application. An event is an instance of an event type (topic).
This method is not supported in Sandbox environment.
|The maximum number of notification topics to return per page from the result set.
|This string value can be used to return the next page in the result set. The string to use here is returned in the next field of the current page of results.
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.
This request requires an access token created with the client credentials 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.
This call has no payload.
This call has no field definitions.
HTTP response headers
This call has no response headers.
The total number of matches for the search criteria.
The path to the call URI that produced the current page of results.
The URL to access the next set of results. This field includes a continuation_token. No prev field is returned, but this value is persistent during the session so that you can use it to return to the next page.
The value of the limit parameter submitted in the request, which is the maximum number of items to return per page, from the result set. A result set is the complete set of results returned by the method.
|array of Topic
An array of topics that match the specified criteria.
The unique identifier for the topic.
The description of the topic.
|array of string
The status of this topic.
The business context associated with this topic.
The scope of this topic.
|array of PayloadDetail
The supported payloads for this topic.
The supported schema version.
|array of FormatTypeEnum
The supported format. Presently,
The supported delivery protocols.
A deprecation indicator.
The indicator of whether this topic is filterable or not.
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.
|Internal Server Error
For more on errors, plus the codes of other common errors, see Handling errors.
|There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
|Invalid limit. Supported ranges 10 - 100.
|Invalid continuation token.
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: Get topics
This method allows applications to browse the details and status of supported topics.
The input specifies the optional limit and continuation_token query parameters. Since no limit is specified in this request, the default value of
20 is used.
If the call is successful, the results including the following fields are returned: topicId, description, status, context, scope, supportedPayloads (including format, schemaVersion, deliveryProtocol, and deprecated), and filterable.