Search CrmBoardColumns

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

GET /api/crm/crmboardcolumns

Search CrmBoardColumns

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/crm/crmboardcolumns \
  --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 CrmBoardColumn represents a stage (step) within a CRM board. In the Nexudus UI these are called CRM Stages.

Each stage has two main components:

• Auto assignment — controls which opportunities are automatically added to this stage. Enable one of the boolean triggers (e.g. TourRequests, SignUps, Cancellations, ProductPurchased) to auto-populate the stage when the corresponding event occurs.
• Auto actions — controls what happens when an opportunity reaches this stage. Assign a message macro (CannedResponseId), a task list (TaskListId), and/or an account action (ActivateAccount, DeactivateAccount, DeleteAccount, ConfirmTour, WinOpportunity, LoseOpportunity).

Stages are ordered by Position within their parent board. Opportunities move through stages either automatically (when conditions are met) or manually.

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

Filters

CrmBoardColumn_CrmBoard · integer

Filter by Crm Board Id.

CrmBoardColumn_CrmBoard_Name · string

Filter by parent CRM board name.

CrmBoardColumn_CrmBoard_Business_Id · integer

Filter by business ID of the parent CRM board.

CrmBoardColumn_CrmBoard_Business_Name · string

Filter by business name of the parent CRM board.

CrmBoardColumn_CrmBoard_Business_Currency_Id · integer

Filter by currency ID of the parent CRM board’s business.

CrmBoardColumn_CrmBoard_Business_Currency_Code · string

Filter by currency code of the parent CRM board’s business.

CrmBoardColumn_Name · string

Filter by stage name (e.g. ‘Contract Signature’, ‘Keys Handout’, ‘Office Tour’).

CrmBoardColumn_Position · integer

Filter by display order of this stage within the board (0-based).

CrmBoardColumn_TourRequests · boolean

Filter by auto-assign: add anyone completing a tour request form to this stage.

CrmBoardColumn_ToursConfirmed · boolean

Filter by auto-assign: add anyone confirming a tour to this stage.

CrmBoardColumn_TourCompleted · boolean

Filter by auto-assign: add anyone completing a tour to this stage.

CrmBoardColumn_WinOpportunity · boolean

Filter by auto-action: mark opportunity as won when added to this stage.

CrmBoardColumn_LoseOpportunity · boolean

Filter by auto-action: mark opportunity as lost when added to this stage.

CrmBoardColumn_SignUps · boolean

Filter by auto-assign: add anyone completing a sign-up form to this stage.

CrmBoardColumn_Bookings · boolean

Filter by auto-assign: add anyone placing a booking to this stage.

CrmBoardColumn_Cancellations · boolean

Filter by auto-assign: add anyone cancelling their contract to this stage.

CrmBoardColumn_ProposalsSent · boolean

Filter by auto-assign: add anyone sent a proposal to this stage.

CrmBoardColumn_ProposalsAccepted · boolean

Filter by auto-assign: add anyone accepting a proposal to this stage.

CrmBoardColumn_DocumentsSigned · boolean

Filter by auto-assign: add anyone e-signing a document to this stage.

CrmBoardColumn_EventRegistrations · boolean

Filter by auto-assign: add anyone registering for an event to this stage.

CrmBoardColumn_ContactMessages · boolean

Filter by auto-assign: add anyone sending a contact message to this stage.

CrmBoardColumn_CannedResponse · integer

Filter by auto-action: message macro to send when an opportunity reaches this stage.

CrmBoardColumn_TaskList · integer

Filter by auto-action: task list to create when an opportunity reaches this stage.

CrmBoardColumn_UseTaskListAsResponsible · boolean

Filter by assign the task list’s own responsible users instead of the opportunity owner.

CrmBoardColumn_ActivateAccount · boolean

Filter by auto-action: activate the account of opportunities added to this stage.

CrmBoardColumn_DeleteAccount · boolean

Filter by auto-action: permanently delete the account and all customer details of opportunities added to this stage.

CrmBoardColumn_DeactivateAccount · boolean

Filter by auto-action: deactivate the account of opportunities added to this stage.

CrmBoardColumn_ConfirmTour · boolean

Filter by auto-action: confirm the tour of opportunities added to this stage.

CrmBoardColumn_ProductPurchased · boolean

Filter by auto-assign: add anyone purchasing a specific product to this stage. Requires Products list.

CrmBoardColumn_ResourceBooked · boolean

Filter by auto-assign: add anyone placing a booking for a specific resource to this stage. Requires Resources list.

CrmBoardColumn_EventCheckins · boolean

Filter by auto-assign: add any event attendee who checks in for an event to this stage.

Range Filters

from_CrmBoardColumn_CrmBoardBusinessId · integer

Filter by business ID of the parent CRM board greater than or equal to this value.

to_CrmBoardColumn_CrmBoardBusinessId · integer

Filter by business ID of the parent CRM board less than or equal to this value.

from_CrmBoardColumn_CrmBoardBusinessCurrencyId · integer

Filter by currency ID of the parent CRM board’s business greater than or equal to this value.

to_CrmBoardColumn_CrmBoardBusinessCurrencyId · integer

Filter by currency ID of the parent CRM board’s business less than or equal to this value.

from_CrmBoardColumn_Position · integer

Filter by display order of this stage within the board (0-based) greater than or equal to this value.

to_CrmBoardColumn_Position · integer

Filter by display order of this stage within the board (0-based) less than or equal to this value.

from_CrmBoardColumn_CreatedOn · string

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

to_CrmBoardColumn_CreatedOn · string

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

from_CrmBoardColumn_UpdatedOn · string

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

to_CrmBoardColumn_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/crmboardcolumns?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/crmboardcolumns?CrmBoardColumn_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

cURL

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

Response

200

Records · CrmBoardColumn[]

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

Partial records — The listing endpoint returns a summary representation of each CrmBoardColumn. The following fields are not populated in the Records[] response: TourRequests, ToursConfirmed, TourCompleted, WinOpportunity, LoseOpportunity, SignUps, Bookings, Cancellations, ProposalsSent, ProposalsAccepted, DocumentsSigned, EventRegistrations, ContactMessages, UseTaskListAsResponsible, ActivateAccount, DeleteAccount, DeactivateAccount, ConfirmTour, ProductPurchased, ResourceBooked, EventCheckins.

To get all fields, fetch the full record using the Get one CrmBoardColumn 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": [
    {
      "CrmBoardId": 0,
      "CrmBoardName": null,
      "CrmBoardBusinessId": null,
      "CrmBoardBusinessName": null,
      "CrmBoardBusinessCurrencyId": null,
      "CrmBoardBusinessCurrencyCode": null,
      "Name": "",
      "Position": 0,
      "CannedResponseId": null,
      "TaskListId": null,
      "Products": [],
      "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": "CrmBoardColumn 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
}