Skip to main content

List entities

GET 
/:organization_id/entities

Returns a paginated and filterable list of entities for an organization.

Filtering: The filters parameter accepts a JSON array of filter objects. Each filter object has:

  • field: The field to filter on (name, code, group_id, schedule_id, holiday_list_id, force_closed, time_zone)
  • comparison: The comparison operator (eq, not_eq, lt, lte, gt, gte, contains, not_contains, start, end, true, false, blank, not_blank)
  • value: The value to compare against (can be a single value or an array of values). Note: Arrays automatically create OR conditions between values.

Examples:

  • Filter by name containing "Test": [{"field":"name","comparison":"contains","value":"Test"}]
  • Multiple filters (AND): [{"field":"name","comparison":"contains","value":"Test"},{"field":"force_closed","comparison":"eq","value":false}]
  • Array of values (OR): [{"field":"name","comparison":"contains","value":["Test","Super"]}]

Request​

Responses​

Successful response