Most Finance API endpoints support filtering based on one or more fields. You can use filters to return a subset of results that you’re interested in. They’ll usually make your response quicker by reducing the amount of data that’s sent in the response.
No filter
api.wisc.edu/finance/gifts
Single filter
api.wisc.edu/finance/gifts?filter[company]=UWGBY
Multiple filters
api.wisc.edu/finance/gifts?filter[company]=UWGBY&filter[giftType]=Donor_Direct
Filters available
Different resources support filtering on different attributes. See the endpoints documentation for details about what’s available on each resource endpoint. If you choose an attribute that it’s not possible to filter on, you’ll get an error message.
Exact vs. fuzzy matches
By default, filters work on exact matches only. For example, api.wisc.edu/finance/projects?filter[name]=UWMIL | Emergency Operations will only return projects with the exact name “UWMIL | Emergency Operations”.
Sometimes you don’t have the full value you’re looking for, or sometimes you want to get a range of results. Some filters support adding an additional operator to the parameter value to enable fuzzy matching.
| Operator | Description | Value type | Example |
|---|---|---|---|
STARTS_WITH: |
Matches values that start with the string passed in | Strings | api.wisc.edu/finance/projects?filter[name]=STARTS_WITH:UWMIL |
ENDS_WITH: |
Matches values that end with the string passed in | Strings | api.wisc.edu/finance/projects?filter[name]=ENDS_WITH:Operations |
CONTAINS: |
Matches values that contain the string passed in anywhere within them | Strings | api.wisc.edu/finance/projects?filter[name]=CONTAINS:Emergency |
LESS_THAN: |
Matches values that are strictly less than the value passed in. Will not return exact matches. | Dates, numbers | api.wisc.edu/finance/projects?filter[endDate]=LESS_THAN:2025-04-01 |
GREATER_THAN: |
Matches values that are strictly greater than the value passed in. Will not return exact matches. | Dates, numbers | api.wisc.edu/finance/projects?filter[startDate]=GREATER_THAN:2025-04-01 |
Not all filters have fuzzy matches enabled. Check the documentation for the specific filter you’re interested in.
Examples
| Query | In English | What it means |
|---|---|---|
api.wisc.edu/finance/projects?filter[company]=UWMIL&Ffilter[startDate]=GREATER_THAN:2025-06-30&filter[name]=CONTAINS:fpm |
Return all projects associated with UWMIL that have a start date after June 30, 2025 and contain “fpm” (not case sensitive) in the name | Future facilities projects at Milwaukee |
api.wisc.edu/finance/projects?filter[endDate]=GREATER_THAN:2025-03-31&filter[endDate]=LESS_THAN:2025-05-01 |
Return all projects with an end date after 2025-03-31 but before 2025-05-01 | Projects with an end date in April 2025 |