> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get one CustomField

> Retrieve a single CustomField record by its Id.

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

<Note>
  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.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the CustomField record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/crm/customfields/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

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

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  Business this custom field belongs to.
</ResponseField>

<ResponseField name="Name" type="string">
  Field label displayed to users.
</ResponseField>

<ResponseField name="DisplayOrder" type="integer">
  Sort order when multiple custom fields are shown together.
</ResponseField>

<ResponseField name="RecordType" type="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.
</ResponseField>

<ResponseField name="FieldType" type="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.
</ResponseField>

<ResponseField name="CoworkerFieldPosition" type="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.
</ResponseField>

<ResponseField name="AvailableOptions" type="string">
  Comma-separated list of choices for Dropdown fields.
</ResponseField>

<ResponseField name="AllowMultipleOptions" type="boolean">
  Whether multiple options can be selected for Dropdown fields.
</ResponseField>

<ResponseField name="CustomFieldIndex" type="integer">
  Unique index identifying this field within its record type and business.
</ResponseField>

<ResponseField name="Required" type="boolean">
  Whether a value must be provided when saving the parent entity.
</ResponseField>

<ResponseField name="GroupName" type="string">
  Optional group name used to visually group related custom fields together.
</ResponseField>

<ResponseField name="DisplayInPublicProfile" type="boolean">
  Show this field on the coworker's public profile page.
</ResponseField>

<ResponseField name="DisplayInDirectorySearch" type="boolean">
  Show this field as a filter in the member directory search.
</ResponseField>

<ResponseField name="NameInSearch" type="string">
  Alternative label shown when this field appears in directory search filters.
</ResponseField>

<ResponseField name="Visibility" type="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.
</ResponseField>

<ResponseField name="DisplayInSignUpForm" type="boolean">
  Show this field on the member sign-up form.
</ResponseField>

<ResponseField name="DisplayInProfileForm" type="boolean">
  Show this field on the member profile edit form.
</ResponseField>

<ResponseField name="DisplayInTourForm" type="boolean">
  Show this field on the tour booking form.
</ResponseField>

<ResponseField name="DisplayInEventSignUpForm" type="boolean">
  Show this field on the event sign-up form.
</ResponseField>

<ResponseField name="ShowInBookingForm" type="boolean">
  Show this field on the resource booking form.
</ResponseField>

<ResponseField name="DisplayInProductSignUpForm" type="boolean">
  Show this field on the product purchase form.
</ResponseField>

<ResponseField name="DisplayInTeamSignUpForm" type="boolean">
  Show this field on the team sign-up form.
</ResponseField>

<ResponseField name="DisplayInCourseSignUpForm" type="boolean">
  Show this field on the course sign-up form.
</ResponseField>

<ResponseField name="DisplayInTariffSignUpForm" type="boolean">
  Show this field on the pricing plan (tariff) sign-up form.
</ResponseField>

<ResponseField name="DisplayInBookingSignUpForm" type="boolean">
  Show this field on the booking sign-up form.
</ResponseField>

<ResponseField name="DisplayInResourceSearch" type="boolean">
  Show this field as a filter in resource search.
</ResponseField>

<ResponseField name="Resources" type="integer[]">
  Resources this custom field is linked to (for FloorPlanDesk or Resource record types).
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "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
}
```