Search CustomFields

Search and list CustomField records with filtering, sorting, and pagination.

GET /api/crm/customfields

Search CustomFields

cURL

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

200

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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-List role.

Enums

eCustomFieldRecordType — RecordType values

Value	Name
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

eFieldType — FieldType values

Value	Name
1	Text
2	LongText
3	Boolean
4	Dropdown
5	Date
6	Integer
7	Decimal

eCoworkerFieldPosition — CoworkerFieldPosition values

Value	Name
1	General
2	Contact
3	Profile
4	Billing
5	Access
6	Notes

eFieldVisibility — Visibility values

Value	Name
1	Visible
2	ReadOnly
3	Internal

Query Parameters

Pagination & Sorting

page · integer · default: "1"

The page number to retrieve.

size · integer · default: "25"

The number of records per page.

orderBy · string

The property name to sort results by (e.g. Name, CreatedOn).

dir · integer

Sort direction. 0 for ascending, 1 for descending.

Filters

CustomField_Business · integer

Filter by business this custom field belongs to.

CustomField_Name · string

Filter by field label displayed to users.

CustomField_DisplayOrder · integer

Filter by sort order when multiple custom fields are shown together.

CustomField_RecordType · integer

Filter by entity type this field applies to: Coworker, Team, Booking, Product, Resource, etc..

CustomField_FieldType · integer

Filter by data type of the field: Text, LongText, Boolean, Dropdown, Date, Integer, or Decimal.

CustomField_CoworkerFieldPosition · integer

Filter by tab where this field appears on the coworker record: General, Contact, Profile, Billing, Access, or Notes.

CustomField_AvailableOptions · string

Filter by comma-separated list of choices for Dropdown fields.

CustomField_AllowMultipleOptions · boolean

Filter by whether multiple options can be selected for Dropdown fields.

CustomField_CustomFieldIndex · integer

Filter by unique index identifying this field within its record type and business.

CustomField_Required · boolean

Filter by whether a value must be provided when saving the parent entity.

CustomField_GroupName · string

Filter by optional group name used to visually group related custom fields together.

CustomField_DisplayInPublicProfile · boolean

Filter by show this field on the coworker’s public profile page.

CustomField_DisplayInDirectorySearch · boolean

Filter by show this field as a filter in the member directory search.

CustomField_NameInSearch · string

Filter by alternative label shown when this field appears in directory search filters.

CustomField_Visibility · integer

Filter by visibility level: Visible (editable by customer), ReadOnly (shown but not editable), or Internal (admin only).

CustomField_DisplayInSignUpForm · boolean

Filter by show this field on the member sign-up form.

CustomField_DisplayInProfileForm · boolean

Filter by show this field on the member profile edit form.

CustomField_DisplayInTourForm · boolean

Filter by show this field on the tour booking form.

CustomField_DisplayInEventSignUpForm · boolean

Filter by show this field on the event sign-up form.

CustomField_ShowInBookingForm · boolean

Filter by show this field on the resource booking form.

CustomField_DisplayInProductSignUpForm · boolean

Filter by show this field on the product purchase form.

CustomField_DisplayInTeamSignUpForm · boolean

Filter by show this field on the team sign-up form.

CustomField_DisplayInCourseSignUpForm · boolean

Filter by show this field on the course sign-up form.

CustomField_DisplayInTariffSignUpForm · boolean

Filter by show this field on the pricing plan (tariff) sign-up form.

CustomField_DisplayInBookingSignUpForm · boolean

Filter by show this field on the booking sign-up form.

CustomField_DisplayInResourceSearch · boolean

Filter by show this field as a filter in resource search.

Range Filters

from_CustomField_DisplayOrder · integer

Filter by sort order when multiple custom fields are shown together greater than or equal to this value.

to_CustomField_DisplayOrder · integer

Filter by sort order when multiple custom fields are shown together less than or equal to this value.

from_CustomField_CustomFieldIndex · integer

Filter by unique index identifying this field within its record type and business greater than or equal to this value.

to_CustomField_CustomFieldIndex · integer

Filter by unique index identifying this field within its record type and business less than or equal to this value.

from_CustomField_CreatedOn · string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CustomField_CreatedOn · string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_CustomField_UpdatedOn · string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CustomField_UpdatedOn · string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/crm/customfields?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Name

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/crm/customfields?CustomField_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/crm/customfields?from_CustomField_UpdatedOn=2025-01-01T00:00&to_CustomField_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records · CustomField[]

The list of CustomField records matching the query. See the Get one CustomField endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each CustomField. The following fields are not populated in the Records[] response: CoworkerFieldPosition, AvailableOptions, AllowMultipleOptions, Required, DisplayInPublicProfile, DisplayInDirectorySearch, NameInSearch, DisplayInSignUpForm, DisplayInProfileForm, DisplayInTourForm, DisplayInEventSignUpForm, ShowInBookingForm, DisplayInProductSignUpForm, DisplayInTeamSignUpForm, DisplayInCourseSignUpForm, DisplayInTariffSignUpForm, DisplayInBookingSignUpForm, DisplayInResourceSearch.

To get all fields, fetch the full record using the Get one CustomField endpoint.

Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

CurrentPage · integer

Current page number.

CurrentPageSize · integer

Number of records per page.

CurrentOrderField · string

The field used for sorting.

CurrentSortDirection · integer

The sort direction (0 = ascending, 1 = descending).

FirstItem · integer

Index of the first item on the current page.

LastItem · integer

Index of the last item on the current page.

TotalItems · integer

Total number of matching records across all pages.

TotalPages · integer

Total number of pages.

HasNextPage · boolean

Whether there is a next page of results.

HasPreviousPage · boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "Name": "",
      "DisplayOrder": 0,
      "RecordType": 0,
      "FieldType": 0,
      "CustomFieldIndex": 0,
      "GroupName": null,
      "Visibility": 0,
      "Resources": [],
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "[e-mail]",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "CustomField Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}