Skip to main content
GET
/
api
/
sys
/
validationrules
/
{id}
Get one ValidationRule
curl --request GET \
  --url https://spaces.nexudus.com/api/sys/validationrules/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "BusinessId": 123,
  "Name": "<string>",
  "RecordType": 123,
  "Active": true,
  "Formula": "<string>",
  "Description": "<string>",
  "ErrorMessage": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
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-Read role.

Path Parameters

id
integer
required
The Id of the ValidationRule record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/validationrules/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

BusinessId
integer
ID of the business linked to this record.
Name
string
The name value for this validation rule.
RecordType
integer
The record type value for this validation rule. See eValidationRuleEntity enum values: 1 = Coworker, 2 = Booking, 4 = CoworkerContract, 5 = Visitor, 6 = CoworkerProduct, 7 = ProposalContract, 8 = CoworkerInvoice, 9 = Teams, 10 = EventAttendees.
Active
boolean
Whether this validation rule is currently active.
Formula
string
The formula value for this validation rule.
Description
string
Free-text description of this validation rule.
ErrorMessage
string
The error message value for this validation rule.
Id
integer
Unique record identifier.
UniqueId
string
UUID of the record.
CreatedOn
string
Date and time the record was created (ISO 8601).
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
UpdatedBy
string
Email of the user who last updated this record.
IsNew
boolean
Whether the record was recently created.
SystemId
string
External system identifier.
Example Response
{
  "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
}