Get one ValidationRule

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>'

import requests

url = "https://spaces.nexudus.com/api/sys/validationrules/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/validationrules/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/validationrules/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/validationrules/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

The name value for this validation rule.

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.

boolean

Whether this validation rule is currently active.

string

The formula value for this validation rule.

string

Free-text description of this validation rule.

string

The error message value for this validation rule.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

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
}

Get multiple ValidationRulesRetrieve multiple ValidationRule records by their Ids in a single request.

Get one ValidationRule

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/validationrules/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/validationrules/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/validationrules/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200