ValidationRules
Search ValidationRules
Search and list ValidationRule records with filtering, sorting, and pagination.
GET
Search ValidationRules
A ValidationRule defines a custom business rule that validates data before it is saved. Rules can be applied to various record types (coworkers, bookings, contracts, visitors, etc.) and enforce custom conditions beyond the standard field validations.
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 business linked to this record.
string
Filter by the name value for this validation rule.
integer
Filter by the record type value for this validation rule.
boolean
Filter by whether this validation rule is currently active.
string
Filter by the formula value for this validation rule.
string
Filter by free-text description of this validation rule.
string
Filter by the error message value for this validation rule.
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
Search ValidationRules