ZUzuper

Get Projects By Filter

Changed on

Rule-engine-based list endpoint — an alternative to the simple filter.* query params on the plain list endpoint, for building complex AND/OR filter conditions. sort_by: "project_priority" is internally remapped to project_priority_index. keyword is embedded inside filter_rules; it matches via Atlas Search when enabled for the company, otherwise falls back to a regex on project_name/project_number_string. Supports fields_to_select and filter.module_uid.

post/projects/filter

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/projects/filter
  • Auth
    API key in header x-api-key

Request body

pageinteger
limitinteger
sort'ASC' | 'DESC'
filter_rule_operator'AND' | 'OR'
sort_by'created_at' | 'updated_at' | 'project_name' | 'project_number' | 'project_due_date' | 'project_start_date' | 'project_priority' | 'project_value'
filter.module_uidstring
fields_to_selectstring
preferred_timezonestring

Response

200

type'success'
dataobject[]

Project documents — same shape as GET /projects.

total_recordsinteger

Changes