Skip to main content
GET
/
api
/
crm
/
customfields
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

​
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.

​
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. 1 for ascending, -1 for descending.

​
Filters

​
CustomField_Business
integer
Filter by Business Id.
​
CustomField_Name
string
Filter by Name.
​
CustomField_DisplayOrder
integer
Filter by Display Order.
​
CustomField_RecordType
integer
Filter by Record Type.
​
CustomField_FieldType
integer
Filter by Field Type.
​
CustomField_CoworkerFieldPosition
integer
Filter by Coworker Field Position.
​
CustomField_AvailableOptions
string
Filter by Available Options.
​
CustomField_AllowMultipleOptions
boolean
Filter by Allow Multiple Options.
​
CustomField_CustomFieldIndex
integer
Filter by Custom Field Index.
​
CustomField_Required
boolean
Filter by Required.
​
CustomField_GroupName
string
Filter by Group Name.
​
CustomField_DisplayInPublicProfile
boolean
Filter by Display In Public Profile.
​
CustomField_DisplayInDirectorySearch
boolean
Filter by Display In Directory Search.
​
CustomField_NameInSearch
string
Filter by Name In Search.
​
CustomField_Visibility
integer
Filter by Visibility.
​
CustomField_DisplayInSignUpForm
boolean
Filter by Display In Sign Up Form.
​
CustomField_DisplayInProfileForm
boolean
Filter by Display In Profile Form.
​
CustomField_DisplayInTourForm
boolean
Filter by Display In Tour Form.
​
CustomField_DisplayInEventSignUpForm
boolean
Filter by Display In Event Sign Up Form.
​
CustomField_ShowInBookingForm
boolean
Filter by Show In Booking Form.
​
CustomField_DisplayInProductSignUpForm
boolean
Filter by Display In Product Sign Up Form.
​
CustomField_DisplayInTeamSignUpForm
boolean
Filter by Display In Team Sign Up Form.
​
CustomField_DisplayInCourseSignUpForm
boolean
Filter by Display In Course Sign Up Form.
​
CustomField_DisplayInTariffSignUpForm
boolean
Filter by Display In Tariff Sign Up Form.
​
CustomField_DisplayInBookingSignUpForm
boolean
Filter by Display In Booking Sign Up Form.
​
CustomField_DisplayInResourceSearch
boolean
Filter by Display In Resource Search.

​
Range Filters

​
from_CustomField_DisplayOrder
integer
Filter by display order greater than or equal to this value.
​
to_CustomField_DisplayOrder
integer
Filter by display order less than or equal to this value.
​
from_CustomField_CustomFieldIndex
integer
Filter by custom field index greater than or equal to this value.
​
to_CustomField_CustomFieldIndex
integer
Filter by custom field index 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 -X GET \
  "https://spaces.nexudus.com/api/crm/customfields?page=1&size=15&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by Name

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

​
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=-1" \
  -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 included 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 (1 = 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,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}