Filter and Search

Overview

Some API endpoints and resources support partial match search and field-based filtering. These are implemented using query parameters in the URL and can be combined.

Syntax

Filter

Filters are applied using field-value pairs:

?field=value&field2=value2&field3=value3

Dates and integer fields can be filtered with the following range operators:

gt – greater than
gte – greater than or equal
lt – less than
lte – less than or equal

Example:

?salary_amount[gt]=50000&salary_amount[lt]=100000

Search

Search is applied by adding a query parameter:

?query=your+search+term

Supported Resources and fields:

Resource	Endpoint(s)	Filter Fields	Search Fields
Company Document	/companies/:company_id/company_document	content_type created_at created_by_user_name	name
Step Template	/companies/:company_id/step_templates /workflow_templates/:workflow_template_id/step_templates	created_at created_by_user_name id task_template_name updated_at updated_by_user_name	display_description display_name name description
Task Template	/companies/:company_id/task_templates /step_templates/:step_template_id/task_templates	assigned_user_name created_at created_by_user_name filename id link_url task_type updated_at updated_by_user_name	display_description display_name name description filenames link_text
Task	/companies/:company_id/tasks /users/:user_id/assigned_tasks /users/:user_id/target_tasks /workflows/:workflow_id/tasks	assigned_user_name assigned_user_role due_at name id target_user_name target_user_status target_user_role workflow_name	assigned_user_name assigned_user_personal_email assigned_user_work_email display_description display_name name description target_user_name target_user_personal_email target_user_status target_user_work_email
Templates	/companies/:company_id/templates /workflow_templates/:workflow_template_id/templates	created_at created_by_user_name id step_template_name task_template_name updated_at updated_by_user_name	display_description display_name name description
User	/companies/:company_id/users	compensation_type employment_type first_task_assigned_at id job_title last_login_at pay_period salary_amount start_date status supervisor_name user_role	last_name legal_first_name personal_email phone preferred_first_name work_email
User Document	/companies/:company_id/user_documents /users/:user_id/user_documents	assigned_user_name created_at signature_required target_user_name task_type	assigned_user_name task_name
Workflow	/companies/:company_id/workflows /users/:user_id/workflows	assigned_user_name id name target_user_name target_user_status task_due_date	description display_description display_name name target_user_name target_user_personal_email target_user_work_email
Workflow Template	/companies/:company_id/workflow_templates /users/:user_id/workflows	created_at created_by_user_name id step_template_name task_template_name updated_at updated_by_user_name	display_description display_name name description

Examples:

Filter user workflows by workflow name

GET /users/1/workflows?name=my%20workflow

Filter company tasks by assigned user name and task name

GET /companies/1/tasks?assigned_user_name=John%20Smith&name=Update%20Personal%20Information

Filter company tasks due within date range

GET /companies/1/tasks?due_at[gt]=2025-05-06T00:00:00Z&due_at[lt]=2025-05-08T00:00:00Z

Filter user documents associated with a specific task type

GET /companies/1/user_documents?task_type=document_upload

Search company users

GET /companies/1/users?query=jane