Skip to main content
GET
/
api
/
crm
/
customfields
/
{id}
{
  "BusinessId": 123,
  "Name": "<string>",
  "DisplayOrder": 123,
  "RecordType": 123,
  "FieldType": 123,
  "CoworkerFieldPosition": 123,
  "AvailableOptions": "<string>",
  "AllowMultipleOptions": true,
  "CustomFieldIndex": 123,
  "Required": true,
  "GroupName": "<string>",
  "DisplayInPublicProfile": true,
  "DisplayInDirectorySearch": true,
  "NameInSearch": "<string>",
  "Visibility": 123,
  "DisplayInSignUpForm": true,
  "DisplayInProfileForm": true,
  "DisplayInTourForm": true,
  "DisplayInEventSignUpForm": true,
  "ShowInBookingForm": true,
  "DisplayInProductSignUpForm": true,
  "DisplayInTeamSignUpForm": true,
  "DisplayInCourseSignUpForm": true,
  "DisplayInTariffSignUpForm": true,
  "DisplayInBookingSignUpForm": true,
  "DisplayInResourceSearch": true,
  "Resources": [
    123
  ],
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

​
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 CustomField-Read role.

​
Path Parameters

​
id
integer
required
The Id of the CustomField record to retrieve.

​
Code Examples

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

​
Response

​
200

​
BusinessId
integer
Business Id.
​
Name
string
Name.
​
DisplayOrder
integer
Display Order.
​
RecordType
integer
Record Type.
​
FieldType
integer
Field Type.
​
CoworkerFieldPosition
integer
Coworker Field Position.
​
AvailableOptions
string
Available Options.
​
AllowMultipleOptions
boolean
Allow Multiple Options.
​
CustomFieldIndex
integer
Custom Field Index.
​
Required
boolean
Required.
​
GroupName
string
Group Name.
​
DisplayInPublicProfile
boolean
Display In Public Profile.
​
DisplayInDirectorySearch
boolean
Display In Directory Search.
​
NameInSearch
string
Name In Search.
​
Visibility
integer
Visibility.
​
DisplayInSignUpForm
boolean
Display In Sign Up Form.
​
DisplayInProfileForm
boolean
Display In Profile Form.
​
DisplayInTourForm
boolean
Display In Tour Form.
​
DisplayInEventSignUpForm
boolean
Display In Event Sign Up Form.
​
ShowInBookingForm
boolean
Show In Booking Form.
​
DisplayInProductSignUpForm
boolean
Display In Product Sign Up Form.
​
DisplayInTeamSignUpForm
boolean
Display In Team Sign Up Form.
​
DisplayInCourseSignUpForm
boolean
Display In Course Sign Up Form.
​
DisplayInTariffSignUpForm
boolean
Display In Tariff Sign Up Form.
​
DisplayInBookingSignUpForm
boolean
Display In Booking Sign Up Form.
​
DisplayInResourceSearch
boolean
Display In Resource Search.
​
Resources
integer[]
Resources.
​
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": "",
  "DisplayOrder": 0,
  "RecordType": 0,
  "FieldType": 0,
  "CoworkerFieldPosition": 0,
  "AvailableOptions": null,
  "AllowMultipleOptions": false,
  "CustomFieldIndex": 0,
  "Required": false,
  "GroupName": null,
  "DisplayInPublicProfile": false,
  "DisplayInDirectorySearch": false,
  "NameInSearch": null,
  "Visibility": 0,
  "DisplayInSignUpForm": false,
  "DisplayInProfileForm": false,
  "DisplayInTourForm": false,
  "DisplayInEventSignUpForm": false,
  "ShowInBookingForm": false,
  "DisplayInProductSignUpForm": false,
  "DisplayInTeamSignUpForm": false,
  "DisplayInCourseSignUpForm": false,
  "DisplayInTariffSignUpForm": false,
  "DisplayInBookingSignUpForm": false,
  "DisplayInResourceSearch": false,
  "Resources": [],
  "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": "CustomField Example",
  "LocalizationDetails": null,
  "CustomFields": null
}