Skip to main content

Query organizations.

POST 

/organizations/query

Query organizations using filters, sorting, and pagination.

Filter

The filter object must have exactly one key. It can be:

  • A property filter (e.g. id, type, name, search, searchName, specializations, public, sysId, externalId, createdBy, resellerId) with an appropriate value.
  • A compound filter with key and (value: array of filter objects; all must match) or or (value: array of filter objects; at least one must match). Each element in an and/or array is again a filter object with the same structure.

Sort

Sort the results by one of the following fields: id, name, city.

Page

Size must be one of: 10, 50, 100, 250.

Request

Responses

Successful operation.

Returns a paginated list of organizations, sorted by id in ascending order by default.