Get multiple CustomFields

Retrieve multiple CustomField records by their Ids in a single request.

GET /api/crm/customfields/?id=[{id1},{id2},{id3}]

Get multiple CustomFields

cURL

curl --request GET \
  --url 'https://spaces.nexudus.com/api/crm/customfields/?id=%5B{id1}%2C{id2}%2C{id3}%5D' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/crm/customfields/?id=%5B{id1}%2C{id2}%2C{id3}%5D"

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=%5B{id1}%2C{id2}%2C{id3}%5D', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Fetch several CustomField records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.

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.

Query Parameters

id · integer[] · required

A comma-separated list of CustomField Ids enclosed in square brackets, e.g. [123,456,789].

Code Examples

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/crm/customfields/?id=[87654321,87654322,87654323]" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const records = await response.json();

import requests

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

records = response.json()

Response

200

Returns an array of CustomField records. Each record has the same structure as the response from the Get one CustomField endpoint.

Partial records — This endpoint returns a summary representation of each CustomField. The following fields are not populated in the 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 this endpoint as the base for a PUT request, as missing fields may be unintentionally cleared.

Example Response

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