Get one CustomField

GET

api

crm

customfields

{id}

Get one CustomField

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

import requests

url = "https://spaces.nexudus.com/api/crm/customfields/{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/crm/customfields/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

A CustomField defines an additional field available for a specific entity type. Nexudus supports attaching arbitrary data to any entity type via the CustomFields array. Each custom field targets a single RecordType (e.g. Coworker, Team, Booking, Product) and has a FieldType that determines how the value is captured and stored (Text, LongText, Boolean, Dropdown, Date, Integer, or Decimal). For Dropdown fields, populate AvailableOptions with a comma-separated list of choices. Set AllowMultipleOptions to true to let users select more than one. The CustomFieldIndex uniquely identifies the field within its record type and business, and is used to map values in the entity’s CustomFields array. Use the Visibility property to control whether the field is Visible, ReadOnly, or Internal (admin-only). The various DisplayIn* flags control where the field appears: sign-up forms, profile forms, tour forms, event sign-up, booking forms, directory search, and public profiles. Custom fields targeting the Coworker record type can be placed in a specific tab using CoworkerFieldPosition (General, Contact, Profile, Billing, Access, or Notes). When RecordType is FloorPlanDesk or Resource, link specific resources via the Resources many-to-many list.

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

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"

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

Business this custom field belongs to.

string

Field label displayed to users.

integer

Sort order when multiple custom fields are shown together.

integer

Entity type this field applies to: Coworker, Team, Booking, Product, Resource, etc.. See eCustomFieldRecordType enum values: 1 = Coworker, 2 = Team, 3 = FloorPlanDesk, 4 = CrmOpportunity, 5 = Visitor, 6 = Proposal, 7 = CoworkerInternal, 8 = HelpDeskMessage, 9 = HelpDeskDepartment, 10 = Product, 11 = Booking, 12 = CoworkerInvoice, 13 = Business, 14 = CoworkerContract, 15 = Tariff, 16 = Resource, 17 = FloorPlan, 18 = InventoryAsset.

integer

Data type of the field: Text, LongText, Boolean, Dropdown, Date, Integer, or Decimal. See eFieldType enum values: 1 = Text, 2 = LongText, 3 = Boolean, 4 = Dropdown, 5 = Date, 6 = Integer, 7 = Decimal.

integer

Tab where this field appears on the coworker record: General, Contact, Profile, Billing, Access, or Notes. See eCoworkerFieldPosition enum values: 1 = General, 2 = Contact, 3 = Profile, 4 = Billing, 5 = Access, 6 = Notes.

string

Comma-separated list of choices for Dropdown fields.

boolean

Whether multiple options can be selected for Dropdown fields.

integer

Unique index identifying this field within its record type and business.

boolean

Whether a value must be provided when saving the parent entity.

string

Optional group name used to visually group related custom fields together.

boolean

Show this field on the coworker’s public profile page.

boolean

Show this field as a filter in the member directory search.

string

Alternative label shown when this field appears in directory search filters.

integer

Visibility level: Visible (editable by customer), ReadOnly (shown but not editable), or Internal (admin only). See eFieldVisibility enum values: 1 = Visible, 2 = ReadOnly, 3 = Internal.

Show this field on the member sign-up form.

boolean

Show this field on the member profile edit form.

boolean

Show this field on the tour booking form.

Show this field on the event sign-up form.

boolean

Show this field on the resource booking form.

Show this field on the product purchase form.

Show this field on the team sign-up form.

Show this field on the course sign-up form.

Show this field on the pricing plan (tariff) sign-up form.

Show this field on the booking sign-up form.

boolean

Show this field as a filter in resource search.

integer[]

Resources this custom field is linked to (for FloorPlanDesk or Resource record types).

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": "",
  "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
}

Get multiple CustomFieldsRetrieve multiple CustomField records by their Ids in a single request.

Get one CustomField

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

import requests

url = "https://spaces.nexudus.com/api/crm/customfields/{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/crm/customfields/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

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