ValidationRules
Search ValidationRules
Search and list ValidationRule records with filtering, sorting, and pagination.
GET
Search ValidationRules
A validation rule is a location-scoped custom expression evaluated when selected records are created or updated; a false result blocks the save with its configured error message.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the ValidationRule-List role.Enums
eValidationRuleEntity — RecordType values
eValidationRuleEntity — RecordType values
Query Parameters
Pagination & Sorting
integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g.
Name, CreatedOn).integer
Sort direction.
0 for ascending, 1 for descending.Filters
integer
Filter by iD of the location that owns this rule; a rule on a network location is also evaluated for records in its child locations.
string
Filter by required internal name for this rule; it is returned as the failure message when ErrorMessage is null.
integer
Filter by record type this rule evaluates: Coworker (customer), Booking, CoworkerContract, Visitor, CoworkerProduct, ProposalContract, CoworkerInvoice, Teams, or EventAttendees.
boolean
Filter by whether this rule is evaluated when a matching record is created or updated; only active rules are selected for evaluation.
string
Filter by required Flee expression that returns true to allow the record and false to reject it; use record, isCreate, isUpdate, user, and the available CustomFunctions as evaluation context.
string
Filter by optional internal notes explaining this rule; not shown to customers.
string
Filter by message returned when Formula evaluates to false; when null, the rule Name is returned instead.
Range Filters
string
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
ValidationRule[]
The list of ValidationRule records matching the query. See the Get one ValidationRule endpoint for the full list of properties returned for each record.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (
0 = ascending, 1 = descending).integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response