Narrow the results of any list endpoint using the conditions query parameter, or build the query visually with the interactive filter builder.
Before you start: You need a working credential — an API token, a JWT, or your existing API key. See Create and Manage API Tokens.
The Basic Pattern
Every list endpoint filters the same way, through a bracketed conditions query parameter:
GET /api/v3/deals.json?conditions[deal_stage][]=3&conditions[deal_created][from_date]=<start date>
Each condition names a field and gives it a value. Stack as many as you need in one call — the filtering chapter in the API docs closes with a worked example combining eight conditions in a single request.
What Each Filter Type Expects
Filter type
What to pass
Record IDs
One or more IDs, as an array
Text
The text to match
Date ranges
A from date and a to date, or a named relative period such as last_quarter
Number ranges
A from value and a to value
Yes/No
A true or false value
The filtering chapter in the API docs covers the exact format for each type, plus how to filter on your own custom fields and how to sort your results.
Run a Saved List View
You don't have to rebuild a filter you've already saved in Pipeline CRM. Any saved list view can be run from the API using its search_id, so the list your team looks at on screen and the list your integration pulls stay identical.
Build a Filter Visually
The interactive filter builder writes the query for you. Pick a list endpoint, then add filters one at a time — each one shows the input its type actually needs: a date range picker for dates, a pair of from and to fields for number ranges, a field that accepts multiple entries for ID lists, and a menu of valid periods for relative dates.
As you build, the page shows four things live:
- A plain-English summary of the filter, so you can confirm it reads the way you intended.
- The query string, just the conditions portion.
- The full URL, ready to paste.
- A code sample in curl, Ruby, Python, or Node.
Sign in and it does two more things:
- Loads your account's own custom fields, so you can pick them by name instead of looking up IDs.
- Gives you a Run button that sends the request against your account and shows the match count and the first rows, as a table or as raw JSON.
The builder captures your whole filter in the page URL. Copy the link to share a prebuilt query with a teammate.
The Run button is read-only. It can only ever read data, never write it — but it does query your real account, not a sandbox.
Which Endpoints Support Filtering
The builder and the conditions parameter cover the list endpoints that support conditions: deals, people, companies, activities, calendar entries, comments, documents, projects, and project milestones.
CSV export endpoints aren't included, since they return a file rather than rows.
Need help? Contact support at customercare@pipelinecrm.com.