Filtering Data in APIs

Knit supports filtering on Unified APIs so you can retrieve only the records relevant to your use case.

Filters are applied by passing query parameters to supported list APIs. This helps reduce unnecessary data transfer, improves efficiency, and makes it easier to build workflows on top of large datasets.

For example, you may want to:

• fetch applications created after a certain date
• retrieve only deals updated since your last sync
• list jobs for a specific status
• narrow down CRM records before processing them in your product

How API filtering works

Filtering in Knit APIs is supported through query parameters on specific endpoints.

When an endpoint supports filters, you can include the relevant query parameters in your request to limit the records returned.

For example, a list endpoint may support filters such as:

• createdAfter
• updatedAfter
• status
• jobId

The exact set of supported filters depends on the category and endpoint.

Why use filters

Using filters on APIs helps you:

• reduce the amount of data returned
• avoid unnecessary processing in your application
• make incremental fetches easier
• improve performance for large datasets
• retrieve only the records relevant to your workflow

This is especially useful for list APIs that may otherwise return a large number of objects.

Filter support is endpoint-specific

Filter support in Knit APIs is defined at the endpoint level.

That means:

• different categories support different filters
• different endpoints within the same category may support different filters
• you should always check the endpoint-specific documentation before depending on a filter in production

For example, the filters supported by List Applications may differ from those supported by List Candidates or List Jobs.

ATS supported filter pages

For ATS APIs, refer to the following pages:

• List Applications
• List Candidates
• List Jobs

These pages document the supported filters for each ATS list API.

CRM supported filter pages

For CRM APIs, refer to the following pages:

• List Accounts
• List Contacts
• List Deals
• List Leads
• List Engagements

These pages document the supported filters for each CRM list API.

Best practices

• Use filters whenever you only need a subset of records
• Prefer time-based filters such as createdAfter or updatedAfter for incremental retrieval
• Check endpoint-specific documentation for the exact supported query parameters
• Do not assume that filters supported by one endpoint are also supported by another endpoint in the same category