/v1/charities/buckets/{bucketId}/search

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint allows you to search a charity bucket. Charity buckets are sets of charities that are eligible for the different features in CSRconnect. You will need to pass the bucket Id for the specific employee and feature the charity will be used for. The endpoints referenced above explain how to retrieve these charity bucket identifiers.



Once you have the bucketId, you can construct a request to search the bucket. In the body of the request, provide the search term, page number, and pageSize. The term is the string which the API will use to search charity name. The page is the page number of the paginated results you want to pull. The pageSize is the number of results per page. There is a limit of 25 results per page.



For each valid request, the api will return a payload of charity results and details for each organization.



Path Params
string
required
Body Params
string
int32
int32
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

400

Bad Request

404

Not Found

500

Server Error

Language
LoadingLoading…
Response
Choose an example:
text/plain
application/json
text/json