This call is used to search for supported charitable organizations. It allows users to search for a specific charitable organization, or for multiple charitable organizations, from a particular charitable domain and/or geographical region, or by using search criteria.
The call returns paginated search results containing the charitable organizations that match the specified criteria.
This method is supported in Sandbox environment. To access the endpoint, just replace the
api.ebay.com root URI with
|q||string||A query string that matches the keywords in name, mission statement, or description. |
|registration_ids||array of string||A comma-separated list of charitable organization registration IDs.|
Note: Do not specify this parameter for query-based searches. Specify either the q or registration_ids parameter, but not both.
|limit||string||The number of items, from the result set, returned in a single page.|
|offset||string||The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output.|
For example, if the offset is set to
HTTP request headers
All requests made to eBay REST operations require you to provide the
Authorization HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
|X-EBAY-C-MARKETPLACE-ID||string||A header used to specify the eBay marketplace ID.|
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.
|charityOrgs||array of CharityOrg|
The list of charitable organizations that match the search criteria.
The ID of the charitable organization.
The description of the charitable organization.
The location details of the charitable organization.
The address of the charitable organization.
The city of the charitable organization.
The state or province of the charitable organization.
The postal code of the charitable organization.
The two-letter ISO 3166 standard of the country of the address.
The geo-coordinates of the charitable organization.
The latitude component of the geographic coordinate.
The longitude component of the geographic coordinate.
The logo of the charitable organization.
The height of the logo image.
The URL to the logo image location.
The width of the logo image.
The mission statement of the charitable organization.
The name of the charitable organization.
The registration ID for the charitable organization.
The link to the website for the charitable organization.
The relative path to the current set of results.
The number of items, from the result set, returned in a single page.
The relative path to the next set of results.
The number of items that will be skipped in the result set. This is used with the limit field to control the pagination of the output.
The relative path to the previous set of results.
The total number of matches for the search criteria.
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.
|500||Internal Server Error|
For more on errors, plus the codes of other common errors, see Handling errors.
|165000||API_CHARITY||APPLICATION||There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.|
|165001||API_CHARITY||REQUEST||Invalid, missing or unsupported marketplace. Please refer to documentation.|
|165003||API_CHARITY||REQUEST||The specified limit is invalid. Maximum value supported is 100.|
|165004||API_CHARITY||REQUEST||The specified offset is invalid.|
|165005||API_CHARITY||REQUEST||Please specify registration_ids OR query text for the search.|
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: Search for Charitable Organizations by Query
This sample retrieves paginated search results containing the charitable organizations that match the query string.
The inputs are the q and limit URI parameters. There is no payload with this request.
If the call is successful, three charitable organizations matching the specified criteria will be returned.
Sample 2: Search for Charitable Organizations by Registration ID
This sample retrieves paginated search results containing the charitable organizations that match the registration IDs.
The input is the registration_ids URI parameter. There is no payload with this request.
If the call is successful, the charitable organization matching the specified registration ID will be returned.