Search CustomFields

GET

api

crm

customfields

Search CustomFields

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

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

fetch('https://spaces.nexudus.com/api/crm/customfields', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

A custom field defines an additional data field for a selected Nexudus record type, including customers, plans, bookings, products, and resources. It controls the input type, validation, visibility, placement, and supported public forms for values stored with those records.

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

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

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

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the location that owns this custom field. Customer fields must belong to the top-level location; other record types are available across the location network..

string

Filter by required label shown for this custom field. It must be unique across the location network unless it is the linked resource/booking counterpart..

integer

Filter by numeric display order for this field among the location’s custom fields; lower values appear first and the server normalizes the ordering after changes..

integer

Filter by record type this field collects data for: Coworker, Team, FloorPlanDesk, CrmOpportunity, Visitor, Proposal, CoworkerInternal, HelpDeskMessage, HelpDeskDepartment, Product, Booking, CoworkerInvoice, Business, CoworkerContract, Tariff, Resource, FloorPlan, InventoryAsset, or Events. A Coworker field cannot later be changed to another type..

integer

Filter by input type and validation for captured values: Text, LongText, Boolean, Dropdown, Date, Integer, or Decimal. AvailableOptions is retained only for Dropdown..

integer

Filter by customer-record tab where the field is placed: General, Contact, Profile, Billing, Access, or Notes. This applies when RecordType is Coworker..

string

Filter by comma-separated permitted choices for a Dropdown field; submitted values must exactly match these trimmed options. The server clears this value for every other FieldType..

boolean

Filter by whether a Dropdown field accepts more than one comma-separated choice. This setting is meaningful only when FieldType is Dropdown..

integer

Filter by server-assigned identifier used to map a customer field to its CustomFields array value. The server assigns it for Coworker fields; do not set it manually..

boolean

Filter by whether a non-empty value is required when this field is submitted on its parent record. ReadOnly fields are automatically made not required..

string

Filter by optional label used to group related custom fields in supported forms..

boolean

Filter by whether this customer field is shown on the customer’s public profile..

boolean

Filter by whether this customer field is offered as a filter in the public customer directory search..

string

Filter by optional label shown for this field in customer-directory search; use it when the normal field label needs different search wording..

integer

Filter by audience and editability: Visible allows customer editing, ReadOnly shows the field without customer editing, and Internal excludes it from public-facing field lists. ReadOnly cannot be Required..

Filter by whether this custom field is shown on the customer sign-up form..

boolean

Filter by whether this custom field is shown on the customer profile-edit form..

boolean

Filter by whether this custom field is shown on the tour request form..

Filter by whether this custom field is shown when a customer registers for an event..

boolean

Filter by whether this field is shown on a resource booking form. For Resource record types, enabling this creates or synchronizes a linked Booking custom field..

Filter by whether this custom field is shown when a customer buys a product..

Filter by whether this custom field is shown on the team sign-up form..

Filter by whether this custom field is shown on the course sign-up form..

Filter by whether this custom field is shown when a customer signs up for a plan (Tariff)..

Filter by whether this custom field is shown on the booking sign-up form..

boolean

Filter by whether this custom field is offered as a filter in resource search..

Range Filters

integer

Filter by numeric display order for this field among the location’s custom fields; lower values appear first and the server normalizes the ordering after changes. greater than or equal to this value.

integer

Filter by numeric display order for this field among the location’s custom fields; lower values appear first and the server normalizes the ordering after changes. less than or equal to this value.

integer

Filter by server-assigned identifier used to map a customer field to its CustomFields array value. The server assigns it for Coworker fields; do not set it manually. greater than or equal to this value.

integer

Filter by server-assigned identifier used to map a customer field to its CustomFields array value. The server assigns it for Coworker fields; do not set it manually. less than or equal to this value.

string

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

string

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

string

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

string

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

Code Examples

Simple listing

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

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/customfields?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/customfields',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Name

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

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/customfields?' + new URLSearchParams({
    CustomField_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/customfields',
    params={
        'CustomField_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/customfields?' + new URLSearchParams({
    from_CustomField_UpdatedOn: '2025-01-01T00:00',
    to_CustomField_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/customfields',
    params={
        'from_CustomField_UpdatedOn': '2025-01-01T00:00',
        'to_CustomField_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

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: DisplayInPublicProfile, DisplayInDirectorySearch, NameInSearch, DisplayInProfileForm, DisplayInTourForm, DisplayInEventSignUpForm, 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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

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

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "Name": "",
      "DisplayOrder": 0,
      "RecordType": 0,
      "FieldType": 0,
      "CoworkerFieldPosition": 0,
      "AvailableOptions": null,
      "AllowMultipleOptions": false,
      "CustomFieldIndex": 0,
      "Required": false,
      "GroupName": null,
      "Visibility": 0,
      "DisplayInSignUpForm": false,
      "ShowInBookingForm": 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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search CustomFields

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

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

fetch('https://spaces.nexudus.com/api/crm/customfields', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200