Skip to main content
GET
/
api
/
sys
/
validationrules
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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.

Query Parameters

Pagination & Sorting

page
integer
default:"1"
The page number to retrieve.
size
integer
default:"25"
The number of records per page.
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
dir
integer
Sort direction. 1 for ascending, -1 for descending.

Filters

ValidationRule_Business
integer
Filter by Business Id.
ValidationRule_Name
string
Filter by Name.
ValidationRule_RecordType
integer
Filter by Record Type.
ValidationRule_Active
boolean
Filter by Active.
ValidationRule_Formula
string
Filter by Formula.
ValidationRule_Description
string
Filter by Description.
ValidationRule_ErrorMessage
string
Filter by Error Message.

Range Filters

from_ValidationRule_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
to_ValidationRule_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
from_ValidationRule_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
to_ValidationRule_UpdatedOn
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/sys/validationrules?page=1&size=15&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/sys/validationrules?ValidationRule_Name=example-value&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/validationrules?from_ValidationRule_UpdatedOn=2025-01-01T00:00&to_ValidationRule_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records
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.
Partial records — The listing endpoint returns a summary representation of each ValidationRule. The following fields are not included in the Records[] response: Formula, Description, ErrorMessage.To get all fields, fetch the full record using the Get one ValidationRule endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
CurrentPage
integer
Current page number.
CurrentPageSize
integer
Number of records per page.
CurrentOrderField
string
The field used for sorting.
CurrentSortDirection
integer
The sort direction (1 = ascending, -1 = descending).
FirstItem
integer
Index of the first item on the current page.
LastItem
integer
Index of the last item on the current page.
TotalItems
integer
Total number of matching records across all pages.
TotalPages
integer
Total number of pages.
HasNextPage
boolean
Whether there is a next page of results.
HasPreviousPage
boolean
Whether there is a previous page of results.
Example Response
{
  "Records": [
    {
      "BusinessId": 0,
      "Name": "",
      "RecordType": 0,
      "Active": false,
      "Formula": "",
      "Description": null,
      "ErrorMessage": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "ValidationRule Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}