ZUzuper

Get Organizations 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. This endpoint is served by a separate microservice from most of the API (not master_service), and its filter schema differs in two ways from other modules' generic-filter endpoints: each filter_rules entry also carries an explicit field_type, and the operator enum is wider (adds GREATER_THAN_EQUAL_TO, LESS_THAN_EQUAL_TO, IN). A filter_rules entry with key: "keyword" is pulled out and used as a free-text search instead of going through the rule engine.

post/organization/filter

Request

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

Request body

pageinteger
limitinteger

Also accepted as count. Max 1000 — larger values return 400 COUNT_LIMIT_EXCEEDED.

countinteger

Alias for limit.

sort'ASC' | 'DESC'
sort_by'organization_name' | 'created_at' | 'updated_at'
filter_rule_operator'AND' | 'OR'
filter.module_uidstring

Comma-separated list of this module's own UIDs to restrict to.

fields_to_selectstring
preferred_timezonestring
cursorstring
prev_cursorstring
cursor_paginationboolean

Switches the response to the cursor-paginated shape.

last_pageboolean

Response

200

type'SUCCESS'
dataobject[]

Organization documents — same shape as GET /organization. Switches to the cursor-paginated shape ({type, data, total_records, paging}, no current_page_records) when cursor_pagination/cursor/prev_cursor/last_page is sent.

current_page_recordsinteger

Length of the data array returned in this page.

total_recordsinteger
current_pageinteger
total_pagesinteger

Changes