Sign in

v1

latestOpenAPI 3.1.02026-08-06492794.7 KB
Projects

Search projects

Search and filter projects using various criteria

get/projects/search

Query parameters

querystring
Example:tax return

Search by project name, linked entity client_id_number, contact email, or contact first/last name

archived'true' | 'false'

Show archived projects (default shows non-archived only)

watching'true' | 'false'

Show only projects the current user is watching

tagstring
Example:urgent

Filter by a single tag name

project_status_idinteger
Example:5

Filter by project status ID

firm_userinteger
Example:123

Filter by user ID (project owner)

sort'name' | 'user' | 'due_date' | 'complete_num' | 'updated_at' | 'pending_tasks_count' | 'completed_tasks_count' | 'client' | 'action_items' | 'last_uploaded' | 'last_visited' | 'project_status_position' | 'first_sent_for_review_at'

Column to sort by

direction'asc' | 'desc'

Sort direction

query_type'and' | 'or'

How to combine advanced filters (used with filters parameter)

type'enum' | 'string' | 'date' | 'number' required

Data type - 'enum' for array fields, 'string' for text, 'date' for dates, 'number' for numeric

field'project_status' | 'tags' | 'contact_tags' | 'entity_tags' | 'owner' | 'watcher' | 'tasks_completion_percentage' | 'name' | 'due_date' | 'created_at' | 'updated_at' required

Field to filter on

criteria'has_any_of' | 'has_all_of' | 'has_none_of' | 'equals' | 'not_equals' | 'less_than' | 'less_than_or_equal_to' | 'greater_than' | 'greater_than_or_equal_to' | 'between' | 'not_between' | 'contains' | 'starts_with' | 'ends_with' | 'does_not_equal' | 'does_not_contain' | 'does_not_start_with' | 'does_not_end_with' | 'before' | 'on_or_before' | 'after' | 'on_or_after' | 'never' required

Filter criteria (depends on field and type)

Advanced filtering array. Each filter has type, field, criteria, and value/values. NOTE: Swagger UI generates filters[0][field]=tags format. Manually change [0] to [] for Rails: filters[][field]=tags For enum fields (project_status, tags, owner, watcher): filters[][type]=enum&filters[][field]=tags&filters[][criteria]=has_any_of&filters[][values][]=tag1 For string fields: filters[][type]=string&filters[][field]=name&filters[][criteria]=contains&filters[][value]=tax For date fields: filters[][type]=date&filters[][field]=due_date&filters[][criteria]=before&filters[][value]=2024-12-31 For numeric fields: filters[][type]=number&filters[][field]=tasks_completion_percentage&filters[][criteria]=greater_than&filters[][value]=75

Response

Successful response with filtered projects

dataobject[]